Questions tagged [swagger]

Also known as OpenAPI Specification is a specification for describing how to produce and consume RESTful web services.

Filter by
Sorted by
Tagged with
1
vote
1answer
140 views

What is the better way to save swagger code gen plugin generated model classes in spring boot maven application?

I am working on a spring boot maven project in Eclipse IDE. And here is my pom.xml. <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/...
1
vote
1answer
80 views

Should I use swagger on all REST APIs?

I am looking to add Swagger documentation to my REST APIs but am wondering if it makes sense to add it to all APIs or not. Most of my APIs will only be used by a UI so if I expose for instance a POST ...
0
votes
0answers
41 views

Open API documentation in function definition? - YAML verbatim vs JavaDoc

Open API [swagger] is a fancy way of writing REST API documentation, it looks like: description: user to add to the system content: 'application/json': schema: $ref: '#/components/schemas/...
4
votes
1answer
421 views

How to properly version an API?

I'm designing an API for our web application, that will be consumed by mobile developers that will create our mobile app. I chose to document it using Swagger / OpenAPI 3.0.0. I'm surprised that when ...
1
vote
0answers
161 views

Automate writing of API tests(postman or other)

I am currently using Postman, Newman and Jenkins to automate the process of testing API end points. The API is being written in Node.js and Express.js. Currently the tests I write with Postman are ...
1
vote
0answers
415 views

How to make rest api end points in swagger UI pre authenticated in Spring BOOT

I have written a spring boot rest API application with OAuth.I have integrated swagger UI for API documentation. I want the API endpoints on swagger UI to be accessible without an access token. Please ...
3
votes
2answers
2k views

How to document REST API before coding

My team is working on a web application using Micro Service Architecture and Angular + Spring MVC. We follow Agile development. For each story, we create few implementation and test tasks. Documenting ...
3
votes
2answers
246 views

Is it legal for a RESTful API to provide different structures for a given resource? How should that be modeled?

I'm using swagger to prototype a RESTful API and I got to a situation where one property is part of a resource but not always should be filled. Let's say my resource is stores. Basic endpoints would ...
3
votes
1answer
390 views

Workflow when using generated code

I'm working with Swagger to generate the API of my application. Swagger is an API specification language that can be used by a code generator to generate code stubs for your application. Obviously you ...