IdentityServer - Implement swagger + gives some SWAGGER samples

simpleidserver / SimpleIdServer

OpenID, OAuth 2.0, SCIM2.0, UMA2.0, FAPI, CIBA & OPENBANKING Framework for ASP.NET Core

https://simpleidserver.com/

Apache License 2.0

686 stars 90 forks source link

IdentityServer - Implement swagger + gives some SWAGGER samples #627

Closed simpleidserver closed 7 months ago

simpleidserver commented 7 months ago

discussion #625

For each realm, create a swagger endpoint : DONE
Add all the operations into swagger : DONE
Add parameters (TOKEN) : DONE
Serialize enum : DONE
Add parameters (AUTHORIZATION) : DONE
Support ReDoc : DONE

Alik2015 commented 7 months ago

What is the swagger endpoint?

simpleidserver commented 7 months ago

For each realm, there is one OPENAPI endpoint exposed. It is used by the Swagger library to display the list of APIs and their operations.

Alik2015 commented 7 months ago

For example?

simpleidserver commented 7 months ago

You can choose between the SWAGGER UI :

Or Redoc :

Alik2015 commented 7 months ago

Sorry I meant the url to access it. Tried localhost:5001/swagger.

simpleidserver commented 7 months ago

No problem!

I'm still working on this ticket :)

There is a first working version in the branch origin/Ticket627. If the property IsRealmEnabled is set to false in the appsettings.json file, you can access the SWAGGER UI via this URL: https://localhost:5001/swagger. Otherwise, if the property is set to true, you can access the UI via this URL: https://localhost:5001/master/swagger.