Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow to provide Open API specification #436

Open
Kaliumhexacyanoferrat opened this issue Jan 3, 2024 · 0 comments
Open

Allow to provide Open API specification #436

Kaliumhexacyanoferrat opened this issue Jan 3, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@Kaliumhexacyanoferrat
Copy link
Owner

Kaliumhexacyanoferrat commented Jan 3, 2024

As the developer of a web service application, I would like to be able to serve a useful Open API specification file, so that my clients can use my services more easily.

Example

var apiSpecification = OpenApi.Create()
                              .Contact(...)
                              .License(...)
                              .Server("https://production.mydomain.com", ...);                                                  

Acceptance criteria

  • The functionality is implemented in a new module
  • All meta data supported by the spec can be added (such as servers or descriptions)
  • The handler allows both JSON and YAML to be generated
  • There an option to generate the spec automatically from the handler tree
  • The generation works for both web services and inline handlers (basically anything that uses the reflection module)
  • The solution is covered by acceptance tests
  • The solution is documented on the website
  • For now, advanced use cases (such as example responses) do not need to be implemented
@Kaliumhexacyanoferrat Kaliumhexacyanoferrat added the enhancement New feature or request label Jan 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant