Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 01c3c27

Browse files
authoredFeb 5, 2021
Update notsupported.rst
1 parent 3ef6abd commit 01c3c27

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed
 

‎docs/introduction/notsupported.rst

+2
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,5 @@ The main reasons why I don't think Swagger makes sense is we already hand roll o
3030
In addition to this many people will configure Ocelot to proxy all traffic like /products/{everything} to their product service and you would not be describing what is actually available if you parsed this and turned it into a Swagger path. Also Ocelot has no concept of the models that the downstream services can return and linking to the above problem the same endpoint can return multiple models. Ocelot does not know what models might be used in POST, PUT etc so it all gets a bit messy and finally the Swashbuckle package doesnt reload swagger.json if it changes during runtime. Ocelot's configuration can change during runtime so the Swagger and Ocelot information would not match. Unless I rolled my own Swagger implementation.
3131

3232
If the user wants something to easily test against the Ocelot API then I suggest using Postman 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 I don't intend to do this.
33+
34+
An alternative could be to use the community package `MMLib.SwaggerForOcelot <link URL>`_. This package covers some common scenarios that you might expect from swagger documentation over API Gateway.

0 commit comments

Comments
 (0)
Please sign in to comment.