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.

Sign up for GitHub

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 info about MMLib.SwaggerForOcelot to notsupported.rst #1429

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from
Open

Add info about MMLib.SwaggerForOcelot to notsupported.rst #1429

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6d34980
Update notsupported.rst
Burgyn Feb 5, 2021
a245c96
Update notsupported.rst
Burgyn Feb 5, 2021
a80ff12
Update notsupported.rst: Add "Swagger Alternatives" subsection
raman-m Aug 23, 2023
67f1c84
Update notsupported.rst: English review
raman-m Aug 23, 2023
aed589d
review by @raman-m
raman-m Jun 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/introduction/notsupported.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,10 @@ Ocelot's configuration can change during runtime so the Swagger and Ocelot infor
Unless we rolled our own Swagger implementation. 😋

If the developer wants something to easily test against the Ocelot API then we suggest using `Postman <https://www.postman.com/>`_ as a simple way to do this.
It might even be possible to write something that maps **ocelot.json** to the Postman JSON spec. However we don't intend to do this.
It might even be possible to write something that maps ``ocelot.json`` to the Postman JSON spec. However we don't intend to do this.

Swagger Alternatives
--------------------

An alternative would be to use the `MMLib.SwaggerForOcelot | GitHub <https://github.com/Burgyn/MMLib.SwaggerForOcelot>`_ community package.
This package covers some of the common scenarios you might expect from Swagger documentation over API Gateway.