Skip to content
GitLab
Projects Groups Topics Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
  • Register
  • Sign in
  • S Storage
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributor statistics
    • Graph
    • Compare revisions
    • Locked files
  • Issues 53
    • Issues 53
    • List
    • Boards
    • Service Desk
    • Milestones
    • Iterations
    • Requirements
  • Merge requests 15
    • Merge requests 15
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
    • Test cases
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Container Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Code review
    • Insights
    • Issue
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • Open Subsurface Data Universe SoftwareOpen Subsurface Data Universe Software
  • Platform
  • System
  • Storage
  • Merge requests
  • !610

Add springdoc openapi latest version

  • Review changes

  • Download
  • Email patches
  • Plain diff
Closed Thulasi Dass Subramanian requested to merge az/td-swagger-springdoc-openapi into master Feb 03, 2023
  • Overview 11
  • Commits 63
  • Pipelines 25
  • Changes 23

Type of change

  • Bug Fix
  • Feature

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 Query, Record, Patch , Info & Health API with OpenAPI 3.0 Annotations
  • 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

Other Changes

  • Configurable descriptions managed in swagger.properties
  • added Integration Test cases for Swagger-UI, api-docs endpoints
  • Hide deprecated [Schema, PubSubEndpoints] related API operations in documentation
  • Deleted HomeController

References

  • https://springdoc.org/faq.html#_can_i_use_spring_property_with_swagger_annotations
  • https://springdoc.org/migrating-from-springfox.html
Edited Feb 09, 2023 by Thulasi Dass Subramanian
Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: az/td-swagger-springdoc-openapi