Breaking News: Grepper is joining You.com. Read the official announcement!

Documenting a Spring REST API Using OpenAPI 3.0

Pragya Keshap answered on March 1, 2023 Popularity 3/10 Helpfulness 1/10

answer Documenting a Spring REST API Using OpenAPI 3.0

Documenting a Spring REST API Using OpenAPI 3.0

Comment

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-ui</artifactId>
    <version>1.6.4</version>
</dependency>
http://localhost:8080/swagger-ui.html
springdoc.swagger-ui.path=/swagger-ui-custom.html
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-webflux-ui</artifactId>
    <version>1.6.4</version>
</dependency>
@GetMapping("/filter")
public Page<Book> filterBooks(@ParameterObject Pageable pageable) {
     return repository.getBooks(pageable);
}
@GetMapping("/filter")
public Page<Book> filterBooks(@ParameterObject Pageable pageable) {
     return repository.getBooks(pageable);
}
@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

Popularity 3/10 Helpfulness 1/10 Language java

Source: Grepper

Tags: api java spring-rest using

Link to this answer
Share Copy Link

Contributed on Mar 01 2023

Pragya Keshap

0 Answers Avg Quality 2/10

Documenting a Spring REST API Using OpenAPI 3.0

Contents

More Related Answers

Documenting a Spring REST API Using OpenAPI 3.0

Grepper

Documentation

Social

Legal

Contact

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