What specification for documenting APIs does springdoc-openapi support?

Pragya Keshap answered on February 17, 2023 Popularity 2/10 Helpfulness 1/10

answer What specification for documenting APIs does springdoc-openapi support?

What specification for documenting APIs does springdoc-openapi support?

Comment

OpenAPI 3 specification

The springdoc-openapi generates API documentation as per OpenAPI 3 specification. Moreover, it also handles the Swagger UI configuration for us, making API document generation a fairly simple task.

@Operation(summary = "Get a book by its id")
@ApiResponses(value = { 
  @ApiResponse(responseCode = "200", description = "Found the book", 
    content = { @Content(mediaType = "application/json", 
      schema = @Schema(implementation = Book.class)) }),
  @ApiResponse(responseCode = "400", description = "Invalid id supplied", 
    content = @Content), 
  @ApiResponse(responseCode = "404", description = "Book not found", 
    content = @Content) })
@GetMapping("/{id}")
public Book findById(@Parameter(description = "id of book to be searched") 
  @PathVariable long id) {
    return repository.findById(id).orElseThrow(() -> new BookNotFoundException());
}

https://www.baeldung.com/spring-rest-openapi-documentation#:~:text=The%20springdoc%2Dopenapi%20generates%20API,generation%20a%20fairly%20simple%20task.

Popularity 2/10 Helpfulness 1/10 Language java

Source: Grepper

Tags: java

Link to this answer
Share Copy Link

Contributed on Feb 17 2023

Pragya Keshap

0 Answers Avg Quality 2/10

What specification for documenting APIs does springdoc-openapi support?

Contents

More Related Answers

What specification for documenting APIs does springdoc-openapi support?

Grepper

Documentation

Social

Legal

Contact

Oops, You will need to install Grepper and log-in to perform this action.