Springfox

External

• http://springfox.github.io/springfox/
• http://springfox.github.io/springfox/docs/current/
• https://github.com/springfox/springfox

Internal

• Generating Swagger/OpenAPI Specification from Spring Code

Overview

Springfox is a suite of Java libraries for automating the generation of machine and human readable specification for JSON APIs written with Spring Framework. Springfox works by examining an application, once, at runtime to infer API semantics based on Spring configurations, class structure and various compile time java annotations.

Gradle Dependencies

repositories {

   jcenter()
}

dependencies {

    implementation "io.springfox:springfox-swagger2:2.9.2"
}

Essential Classes

• springfox.documentation.spring.web.plugins.Docket: the primary API configuration mechanism.
• ApiSelectorBuilder provides fine grained control over the endpoints exposed via swagger.

Annotations

• @EnableSwagger2

Security Schemas

The following security schemas are available to protect the API:

• ApiKey
• BasicAuth
• OAuth

Models

Non-reachable Model

A model that should be described in the generated specification but is not explicitly used in any operation.

Generating Swagger/OpenAPI Specification from Spring Code with Springfox

https://springframework.guru/spring-boot-restful-api-documentation-with-swagger-2/

http://springfox.github.io/springfox/docs/current/

General Considerations

How is the artifact generated? Where?

UI Support

dependencies {

    compile 'io.springfox:springfox-swagger-ui:2.9.2'
}