Skip to content

Latest commit

 

History

History

sctp-api

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
src/main
src/main
 
 
.classpath
.classpath
 
 
.project
.project
 
 
README.md
README.md
 
 
application-prod-example.yaml
application-prod-example.yaml
 
 
pom.xml
pom.xml
 
 

README.md

SCTP MIS API

API component of the SCTP2 platform

Development

  • API Documentation: OpenDoc + Swagger UI

Building, Configuration & Deployment

Refer to ../README.md

API Documentation

We are using the Open API Standard. Spring boot exposes the following URLs:

  • ${basepath}/api-doc

    Outputs the machine-readable API documentation in JSON format. The output can be pasted and viewed/edited in Swagger Editor or shared.

  • ${basepath}/api-doc.yaml

    Same as the first one but in YAML format.

  • ${basepath}/swagger-ui.html

    Human-readable comprehensive view of the entire API documentation.

NOTE

The above URLs are not accessible by default. To access the URLs, set the following properties to true in your configuration file. It's recommended to only enable them in development mode.

springdoc:
  api-docs:
    enabled: false
  swagger-ui:
    enabled: false