Questions tagged [openapi]
The question is about the OpenAPI / Swagger specification.
8 questions
1
vote
2
answers
176
views
API design: handling multiple user account types
I’m designing a REST API where a single person can hold multiple account types.
For example, one person might have both a CareProvider and a CareSeeker account.
Each account type can have its own ...
- 19
0
votes
1
answer
126
views
OpenAPI - `v0.x.x` as a way to denote unstability
In OpenAPI, is there a convention for denoting that your API is not stable yet?
In semantic versioning, the v0.x.x version number is usually used to indicate that the project is not stable yet. ...
- 123
0
votes
0
answers
161
views
How to Handle Undocumented Fields in OpenAPI Schema?
I'm working with an API that uses OpenAPI for its schema documentation. However, there are certain fields in the request body that shouldn't be visible to all consumers, for example, internalProperty: ...
- 117
0
votes
1
answer
2k
views
Handling OpenAPI Generated code in a Project's repository
In my company, we are would like to recommend OpenAPI and using the design first approach to API development. We would also like to use the OpenAPI Generator to generated server stubs and DTOs from ...
- 139
0
votes
2
answers
508
views
How to keep OpenAPI specification up-to-date and compliant without using code generators?
In our company, there is no standard for how to document APIs. Missing API documentation slows down the development process.
Therefore, we want to introduce OpenAPI.
We want to use code generators to ...
- 207
1
vote
2
answers
2k
views
Is it OK to return different DTOs for the same endpoint when the user is logged in vs when it is anonymous?
Say that I have a REST endpoint for a chess server. If I'm not logged in and do a GET on /games I could get all running games like:
{
running_games: [
.....
]
}
but if I'm logged in I ...
- 423
4
votes
1
answer
563
views
Share models between AsyncAPI and RESTful APIs?
What I try to solve:
Given I run a set of microservices, most of which expose a RESTful API and additionally publish or consume events via messaging broker,
and I have decided to go "API first&...
- 167
5
votes
2
answers
3k
views
Semantic Versioning in OpenAPI with string "enum": new values OK?
My team is preparing to add new capabilities to an OpenAPI contract and our implementation of it. There are pre-existing clients. We are planning to take our API from v1.1 to v1.2 while fully ...
- 491