Generate Swagger using springdoc-openapi OAS 3.0
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 catalog API
- CRS Get Catalog Attributes
- Get all Areas Of Use
- Get one Area Of Use API
- Get all Coordinate Reference Systems API
- Get one Coordinate Reference Systems API
- Get all LateBoundCRS API
- Get one LateBoundCRS API
- Get all EarlyBoundCRS API
- Get One EarlyBoundCRS API
- Get all CompoundCRS API
- Get One CompoundCRS API
- Get all Cartographic Transformations API
- Get one Cartographic Transformations API
- Get all SingleCT API
- Get One SingleCT API
- Get all CompoundCT API
- Get One CompoundCT API
- Search Area Of Use API
- Search Coordinate Reference Systems API
- Search Cartographic Transformations API
- HealthCheck API
- Info API
-
Documented the below API's with OpenAPI 3.0 Annotations (API Version 3)
- Info API
- Get all Coordinate Transformations API
- Get one Coordinate Transformations API
- Get all Coordinate Reference Systems API
- Get one Coordinate Reference Systems API
- Area of Use 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/catalog/swagger (will redirect to https://osdu-glab.msft-osdu-test.org/api/crs/catalog/swagger-ui/index.html)
- api-docs [All Versions] (JSON) : https://osdu-glab.msft-osdu-test.org/api/crs/catalog/api-docs
- api-docs [All versions] (YAML) :https://osdu-glab.msft-osdu-test.org/api/crs/catalog/api-docs.yaml
- api-docs [Version V2] (JSON) : https://osdu-glab.msft-osdu-test.org/api/crs/catalog/api-docs/v2
- api-docs [Version V3] (JSON) : https://osdu-glab.msft-osdu-test.org/api/crs/catalog/api-docs/v3
-
Other Changes
- Configurable descriptions managed in swagger.properties
- Deleted HomeController
Edited by Jayesh Bagul