Springfox: Difference between revisions
Jump to navigation
Jump to search
| Line 12: | Line 12: | ||
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. | 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. | ||
The primary API configuration mechanism is <tt>springfox.documentation.spring.web.plugins.Docket</tt>. | |||
=Gradle Dependencies= | =Gradle Dependencies= | ||
Revision as of 20:13, 14 February 2019
External
- http://springfox.github.io/springfox/
- http://springfox.github.io/springfox/docs/current/
- https://github.com/springfox/springfox
Internal
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.
The primary API configuration mechanism is springfox.documentation.spring.web.plugins.Docket.
Gradle Dependencies
repositories {
jcenter()
}
dependencies {
compileOnly "io.springfox:springfox-swagger2:2.9.2"
}
Annotations
Generating Swagger/OpenAPI Specification from Spring Code with Springfox
General Considerations
How is the artifact generated? Where?