Ask a Question

Documenting tokenURL and authorization

MarkWoulfeNeo4j
Occasional Visitor

Documenting tokenURL and authorization

Hello,

 

I am currently documenting an API for the company I work for and want to document the authorization process itself, for those users who will be authenticating outside of the Swagger UI.

 

Is this something I can viably do within the Swagger UI itself? https://swagger.io/docs/specification/authentication/oauth2/ says you can describe tokenUrl if you need it but doesn't go into much detail on the best way to do this.

 

I do have the option of documenting this process outside of the Swagger UI in our standard product docs, we just don't have any of the nice UI/UX that Swagger UI offers for documenting endpoints.

 

Interested in hearing and seeing how others have documented the authorization process.

 

Thanks,

Mark

0 REPLIES 0
cancel
Showing results for 
Search instead for 
Did you mean: