Skip to content

dd-bim/DatacatRestApi

Repository files navigation

datacat REST API

This API for datacat is based on a restful approach and realised with OpenAPI. By default the API points on the domain for the ontology IBPDI.

Documentation

A documentation file can be found in /doc. The file provides all information to work out the business logic of the REST API. A package overview, a step-by-step instruction for an update as well as the generator-ignore list are provided.

Usage and License

You can view the api documentation in swagger-ui by pointing to http://localhost:3001/swagger-ui.html

Change default port value in application.properties if necessary.

OpenAPI based API

The underlying library integrating OpenAPI to Spring Boot is springdoc. Springdoc will generate an OpenAPI v3 specification based on the generated Controller and Model classes.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published