pathaniaamn
New Contributor
Joined 2 years ago
User Profile
User Widgets
Contributions
Re: API specification | URI Versioning, security with api key/secret and Okta/Auth0, forming request/res
Update: Authentication worked using apiKey as well. Though, I am stuck in a weird issue. I am preparing a GET request and getting an error as below. Based on the error, request header should be declared. So, I want to declare request header as application/json but I am not able to as it is not supported in openapi: 3.0.0 415 Undocumented Error: response status is 415 Response body Download { "message": "Request validation can only interpret application/json bodies. You must provide \"Content-Type: application/json\" in the request headers." } It was supported in openapi: 2.0.0 as mentioned in the link below. https://swagger.io/docs/specification/2-0/mime-types/ and in openapi: 3.0.0 there is nothing mentioned how to handle this for a GET request as all examples state information for responses. https://swagger.io/docs/specification/media-types/ Did anyone face issue like this?786Views0likes1CommentRe: API specification | URI Versioning, security with api key/secret and Okta/Auth0, forming request/res
Update: 1. Versioning resolved. all set there. How I fixed it. Here is the sample yaml : openapi: 3.0.0 servers: # Added by API Auto Mocking Plugin - description: SwaggerHub API for Aman url: https://virtserver.swaggerhub.com/aman/1.0.0 This will ensure versioning is applied for all endpoints. 2. Regarding authentication - Able to configure API Mocking. All set here as well. So, I am seeing responses with HTTP 200 (Refer to this link for more information - https://support.smartbear.com/swaggerhub/docs/integrations/api-auto-mocking.html) Now, I am working on getting on how to get request headers and response headers for my APIs. Please message here if you have any information on that.804Views0likes0CommentsRe: API specification | URI Versioning, security with api key/secret and Okta/Auth0, forming request/res
Thanks chichepo This was very helpful. Here is an update - 1. Versioning resolved. all set there. 2. Regarding authentication - I don't have Okta to be tied to it. Can i use something to behave like dummy authentication? I just want to make sure my request and responses work. Currently, I have defined request and responses in swagger but unable to feature "try it out" as I get an error Error: response status is 404 Response body Download file Response headers cache-control: no-cache content-length: 0 content-type: application/octet-stream date: Thu,16 Mar 2023 16:49:16 GMT etag: W/"0-2jmj7l5rSw0yVb/vlWAYkK/YBwk" expires: -1 status: 404 Not Found Related issues with #2: I have defined my request and response for application/json but I see content-type: application/octet-stream in response when I execute the endpoint. Here is my configuration: paths: /portfolios: post: tags: - portfolio summary: create a new portfolio description: >- This endpoint creates a new portfolio in the system with its unique name and enumeration. operationId: addPortfolio requestBody: description: Create a new portfolio in the system. content: application/json: schema: $ref: '#/components/schemas/create-portfolio' required: true responses: '200': description: Portfolio created successfully. content: application/json: schema: $ref: '#/components/schemas/portfolio-created' Your quick response is much appreciated.799Views0likes1CommentAPI 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.928Views0likes6Comments