Software Engineering Stack Exchange
Software Engineering Stack Exchange

Questions tagged [swagger]

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

There is a score of tools for generating code stubbs and documentation based on the OpenAPI Specification (formerly known as Swagger)

10 questions
5
votes
1 answer

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 I create a new OpenAPI document on Swagger, I get…
BenMorel
  • 283
  • 2
  • 9
5
votes
2 answers

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 be: GET: /stores - returns a list of store GET:…
Rodrigo Lira
  • 153
  • 4
3
votes
2 answers

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 REST API is the first task to be done in the…
TechCrunch
  • 613
  • 2
  • 10
  • 17
3
votes
1 answer

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 have to complete these stubs with some…
David George
  • 141
  • 4
1
vote
1 answer

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.
happytohelp
  • 133
  • 4
1
vote
1 answer

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 endpoint wouldn't it compromise the database with…
linuxNoob
  • 183
  • 6
1
vote
0 answers

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 being saved to a git repo, being fetched by…
goldfishalpha
  • 119
  • 1
1
vote
0 answers

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. This is my swagger config : package com.XXX; …
Curious
  • 11
  • 1
0
votes
2 answers

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 ensure that the OpenAPI specification is…
Harold L. Brown
  • 207
  • 1
  • 5
0
votes
2 answers

Golang Design Pattern for Generating View Objects in a REST API?

I have moderate Golang experience and lots of experience in other programming languages such as Java, Python, Rust, Scala, and others. I'm comfortable with building REST services and most of the other related topics, so the concept in general isn't…
Naftuli Kay
  • 1,601
  • 2
  • 16
  • 23