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

Add docs on how one can extend the Swagger docs #45

Closed
Piedone opened this issue Mar 6, 2022 · 3 comments
Closed

Add docs on how one can extend the Swagger docs #45

Piedone opened this issue Mar 6, 2022 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@Piedone
Copy link

Piedone commented Mar 6, 2022

As a module developer, what do I need to do to get my APIs into the Swagger docs? And after that, what do I need to do to display some nice documentation there for my API operations?

Please document under https://github.com/OrchardCoreContrib/OrchardCoreContrib.Modules/blob/dev/src/OrchardCoreContrib.Apis.Swagger/README.md

@hishamco
Copy link
Member

hishamco commented Mar 7, 2022

This is a first release, there's a plan to extend Swagger to configure it's options, please refer to #34

what do I need to do to get my APIs into the Swagger docs?

This is good point to document

And after that, what do I need to do to display some nice documentation there for my API operations?

I suggest to refer to Swagger or ASP.NET Core docs, your thoughts?

@hishamco hishamco added the documentation Improvements or additions to documentation label Mar 7, 2022
@Piedone
Copy link
Author

Piedone commented Mar 7, 2022

Sounds good.

@hishamco
Copy link
Member

Fixed in e54e130

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants