API specification | URI Versioning, security with api key/secret and Okta/Auth0, forming request/res
I am first time user of Swagger and have very rookie questions but as I could not find the answers anywhere, I believe this would help to document this for clarity to new users in future as well.
I am working on a new project for which there is code base yet and I would like to create a API documentation in such a way that it could be used once project is established as well -
1. How can demonstrate URI based versioning? (remember there is no code base for this project yet. I am building a skeleton of the design that could be an input for developers to build their BE services)
2. authentication - how are these endpoints authenticated? Do i have to bind an okta service to make it work? or can i use something as dummy authentication to make it work?
3. One thing I noticed is that every request and response would be different. Does that mean for every verb (GET, POST) with endpoint, I would have to create two schemas - one for request and other for response. I was not able to reuse the schema and thats where my problem is.