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.6.14
- used @OpenAPIDefinition annotation to populate OpenAPI Object fields [info, tags, servers, security]
- Documented the below API's with OpenAPI 3.0 Annotations
- Delivery API
- File API
- FileCollectionDms API
- FileDelivery API
- FileDms API
- FileList API
- FileLocation API
- FileMetadata 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
- Azure Swagger GLAB(for Reference)
- Swagger UI: https://osdu-glab.msft-osdu-test.org/api/file/v2/swagger (will redirect to https://osdu-glab.msft-osdu-test.org/api/file/v2/swagger-ui/index.html)
- api-docs (JSON) : https://osdu-glab.msft-osdu-test.org/api/file/v2/api-docs
- api-docs (YAML) :https://osdu-glab.msft-osdu-test.org/api/file/v2/api-docs.yaml
- Marked the below Internal API's as Hidden
- Delivery API
- POST /v2/delivery/GetFileSignedUrl
- File API
- POST /v2/getFile
- FileCollectionDms API
- POST /v2/file-collections/storageInstructions
- POST /v2/file-collections/retrievalInstructions
- POST /v2/file-collections/copy
- FileDms API
- POST /v2/files/storageInstructions
- POST /v2/files/retrievalInstructions
- POST /v2/files/copy
- FileList API
- POST /v2/getFileList
- FileLocation API
- POST /v2/getLocation
- POST /v2/getFileLocation
- Delivery API
Other Changes
- Configurable descriptions managed in swagger.properties
- Deleted HomeController
- Updated Readme for swagger related information