Provide a OpenAPI specification of the REST API
dellerDLR opened this issue · 0 comments
dellerDLR commented
Prerequisites
- I have written a descriptive issue title
- I have verified that I am running the latest version of the COMET Web Services
- I have searched open and closed issues to ensure it has not already been reported
Description
An OpenAPI specification is a machine-readable interface definition language for describing, producing, consuming and visualizing web services [1].
Especially for first time users an OpenAPI specification can help a lot to understand and consume an API.
But also for external tools an OpenAPI specification helps with the integration.
Ideally, the specification is auto-generated through the source code.
At DLR we have the use case to enable interoperability between different modeling tools. For that we develop a tool that utilizes OpenAPI specifications of the tools to be connected.
Steps to Reproduce
System Configuration
- COMET Web Services version:
- CDP4Common:
- PostrgreSQL:
- Other:
- Environment (Operating system, version and so on):
- .NET Framework version:
- Mono version:
- Additional information: