OpenAPI 3.0 Documentation using springdoc
Link to ADR(Architecture Decision Record) : Swagger using springdoc-openapi
OpenAPI 3.0 related changes
- upgraded to latest springdoc openapi latest version 1.7.0
- Documented the below API's with OpenAPI 3.0 Annotations (API Version 2)
- CRS Convert List Point API
- CRS Convert GeoJson API
- CRS Convert Trajectory Stations API
- HealthCheck API
- Info API
- Documented the below API's with OpenAPI 3.0 Annotations (API Version 3)
- CRS Convert List Point API
- CRS Convert GeoJson API
- CRS Convert Trajectory Stations API
- CRS Convert BinGrid API
- HealthCheck API
- Info API
- Added the standard HTTP Response(4xx, 5x****x) for API Responses
- Custom Path for
- Swagger UI: https://host/context-path/swagger (will redirect to https://host/context-path/swagger-ui/index.html)
- api-docs (JSON) : https://host/context-path/api-docs
- api-docs (YAML) : https://host/context-path/api-docs.yaml
- Multi Versions API:
- Swagger UI: https://host/context-path/swagger (drop down menu for each version) redirects: (https://host/context-path/swagger-ui/index.html?urls.primaryName=version)
- api-docs (JSON) : https://host/context-path/api-docs/version (v2 | v3)
- Azure Swagger GLAB(for Reference)
- Swagger UI: https://osdu-glab.msft-osdu-test.org/api/crs/converter/swagger (will redirect to https://osdu-glab.msft-osdu-test.org/api/crs/converter/swagger-ui/index.html)
- api-docs [All Versions] (JSON) : https://osdu-glab.msft-osdu-test.org/api/crs/converter/api-docs
- api-docs [All versions] (YAML) :https://osdu-glab.msft-osdu-test.org/api/crs/converter/api-docs.yaml
- api-docs [Version V2] (JSON) : https://osdu-glab.msft-osdu-test.org/api/crs/converter/api-docs/v2
- api-docs [Version V3] (JSON) : https://osdu-glab.msft-osdu-test.org/api/crs/converter/api-docs/v3
- Other Changes
- Configurable descriptions managed in swagger.properties
- Deleted HomeController
Edited by Jayesh Bagul