# springfox/springfox

Automated JSON API documentation for API's built with Spring

Repository: https://github.com/springfox/springfox
Canonical: https://ross.abutalabs.com/products/springfox
Homepage: http://springfox.io
Language: Java
License: Apache-2.0
License Family: permissive
Topics: springfox, java, swagger, oai, spring, spring-boot, spring-data-rest, openapi
Last push: 2024-03-18T18:36:28+00:00

## Health v2 (maintenance only)
Score: 23/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 0, release rhythm 8, longevity 100
- inputs: {"age_days": 5232, "days_push": 898, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 5930, forks 1510 (observed 2026-08-28T04:09:32.431882+00:00)

## What it is
Springfox is a Java library that automatically generates JSON API documentation (Swagger/OpenAPI) for APIs built with the Spring framework, including Spring Boot and Spring Data REST. It scans Spring controllers and produces interactive Swagger UI documentation from the code.

## Use cases
- generate swagger docs for spring boot rest api
- auto-generate openapi specification from spring controllers
- add interactive api documentation ui to a spring app
- document spring data rest endpoints automatically
- produce swagger 2.0 / openapi 3 json for a java spring service

## When to choose
- you have a Spring or Spring Boot API and want documentation generated from code with minimal configuration
- you need Swagger UI and OpenAPI JSON for existing Spring MVC or Spring Data REST endpoints

## When to avoid
- starting a new project on recent Spring Boot 3.x versions, where springdoc-openapi is the actively maintained alternative
- you need cutting-edge OpenAPI 3.1 support or frequent updates

## Facets
- artifact type: library
- maturity: maintenance
- function: api-documentation, documentation, sdk
- domain: apis, web-development, developer-tools, documentation
- platform: jvm
- tags: swagger, openapi, spring-boot, spring-data-rest, api-docs, json-api, spring

## Member repositories
- springfox/springfox (main) score 23

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:09:32.431882+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-29T17:50:48.874258+00:00, confidence not recorded.
  - readme: https://github.com/springfox/springfox (fetched 2026-08-28T04:09:32.431882+00:00, sha 77928786f9b7)
  - homepage: http://springfox.io (fetched 2026-08-29T08:46:28.136053+00:00, sha 53c779ee8bbd)
- Data as of 2026-08-30T08:39:29.467469+00:00.