Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
S
Schema
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
OSDU Software
OSDU Data Platform
System
Schema
Merge requests
!470
OpenAPI 3.0 Documentation using springdoc
Code
Review changes
Check out branch
Download
Patches
Plain diff
Merged
OpenAPI 3.0 Documentation using springdoc
az/td-oas
into
master
Overview
3
Commits
4
Pipelines
10
Changes
24
Merged
Thulasi Dass Subramanian
requested to merge
az/td-oas
into
master
1 year ago
Overview
3
Commits
4
Pipelines
10
Changes
24
Expand
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
Schema API
System Schema 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/schema-service/v1/swagger
(will redirect to
https://osdu-glab.msft-osdu-test.org/api/schema-service/v1/swagger-ui/index.html
)
api-docs (JSON)
:
https://osdu-glab.msft-osdu-test.org/api/schema-service/v1/api-docs
api-docs (YAML)
:
https://osdu-glab.msft-osdu-test.org/api/schema-service/v1/api-docs.yaml
Other Changes
Configurable
descriptions managed in
swagger.properties
Deleted HomeController
Marked the 'WhoamiController' as 'Hidden' for documentation
Updated Readme for swagger related information
References
https://springdoc.org/faq.html#_can_i_use_spring_property_with_swagger_annotations
https://springdoc.org/migrating-from-springfox.html
0
0
Merge request reports
Compare
master
version 2
619a616e
1 year ago
version 1
9b5d1d36
1 year ago
master (base)
and
latest version
latest version
07cad26b
4 commits,
1 year ago
version 2
619a616e
2 commits,
1 year ago
version 1
9b5d1d36
1 commit,
1 year ago
24 files
+
265
−
74
Inline
Compare changes
Side-by-side
Inline
Show whitespace changes
Show one file at a time
Files
24
Search (e.g. *.vue) (Ctrl+P)
provider/schema-aws/src/main/java/org/opengroup/osdu/schema/provider/aws/SchemaAwsApplication.java
+
2
−
0
Options
@@ -16,10 +16,12 @@ package org.opengroup.osdu.schema.provider.aws;
import
org.springframework.boot.SpringApplication
;
import
org.springframework.boot.autoconfigure.SpringBootApplication
;
import
org.springframework.context.annotation.ComponentScan
;
import
org.springframework.context.annotation.PropertySource
;
@SpringBootApplication
(
exclude
=
{
org
.
springframework
.
boot
.
autoconfigure
.
security
.
servlet
.
SecurityAutoConfiguration
.
class
})
@ComponentScan
({
"org.opengroup"
})
@PropertySource
(
"classpath:swagger.properties"
)
public
class
SchemaAwsApplication
{
public
static
void
main
(
String
[]
args
)
{
SpringApplication
.
run
(
SchemaAwsApplication
.
class
,
args
);
Loading