Reading time ∼6 mins

API Documentation with Springfox 3


This post is old. Some information may be inaccurate.

Table of contents

Recently, the popular Springfox project released the long-awaited v3 of their library with support for OpenAPI 3 and Spring 5 (only annotation-based API is supported). It also comes with a ready-to-use Spring Boot starter which replaces a host of dependencies that were required in earlier versions. This version fills a lot of gaps that another project springdoc-openapi had addressed for a while.

In this post, we'll explore similar usecases that we'd covered in an earlier post on springdoc-openapi.


The code written for this post uses:

  • Java 14
  • Spring Boot 2.3.3
  • Springfox Boot Starter 3.0.0
  • Postgres 13 running in a Docker container
  • Maven 3.6.3

To run Postgres in a Docker container, use the following Compose file.

version: '3'

    image: postgres:13-alpine
    container_name: pg13
    restart: always
      - 5432:5432
      POSTGRES_USER: erin
      POSTGRES_PASSWORD: richards

Execute the following command to launch the container.

docker-compose up -d

Springfox 3 with Spring WebMvc

Generate a Spring Boot project using Spring Initializr, and add spring-boot-starter-web, spring-boot-starter-data-jdbc, postgresql, and spring-boot-starter-actuator dependencies. Your pom.xml would look like this.

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns=""

    <relativePath/> <!-- lookup parent from repository -->









Rename to application.yml, open it in an editor, and add the following configuration (change it wherever required).

# src/main/resources/application.yml

    platform: postgres
    url: jdbc:postgresql://localhost:5432/spring
    username: erin
    password: richards

Create some endpoints

Let's create some endpoints that we can show in the documentation. Say, we want to create a CRUD API for a Note object in a Postgres relation defined by the following statement.

  title TEXT,
  content TEXT

Define an entity for this relation as follows.

// src/main/java/dev/mflash/guides/springfox3/

public class Note {

  private @Id long id;
  private String title;
  private String content;

  // getters, setters, etc

Postgres will generate the id automatically when a save operation is performed since the id field is of SERIAL type.

Declare a repository to perform CRUD operations with the Note entity.

// src/main/java/dev/mflash/guides/springfox3/

public interface NoteRepository extends CrudRepository<Note, Long> {


Expose some of the CRUD operations through a controller.

// src/main/java/dev/mflash/guides/springfox3/

public class NoteController {

  private final NoteRepository repository;

  public NoteController(NoteRepository repository) {
    this.repository = repository;

  public List<Note> save(@RequestBody List<Note> notes) {
    List<Note> savedNotes = new ArrayList<>();
    return savedNotes;

  public List<Note> findAll() {
    List<Note> savedNotes = new ArrayList<>();
    return savedNotes;

  @PostMapping(consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
  public List<Note> upload(@RequestParam("data") MultipartFile csv) throws IOException {
    List<Note> savedNotes = new ArrayList<>();
    List<Note> notes = new BufferedReader(
        new InputStreamReader(Objects.requireNonNull(csv).getInputStream(), StandardCharsets.UTF_8)).lines()
    return savedNotes;

  public boolean delete(@PathVariable("id") long id) {
    return true;

Here, apart from other endpoints, we've exposed an endpoint, through the upload method, to upload a CSV of notes and persist them in the database.

Integrating Springfox 3

Add the Springfox Boot Starter in the pom.xml.


Annotate the NoteController with a @Tag annotation. This is not required but using a tag, we can provide a description for the controller with the Docket API later.

// src/main/java/dev/mflash/guides/springfox3/

@Api(tags = "Note")
public class NoteController {

  // rest of the code

Customize the metadata and the description of the above controller by injecting a Docket bean.

// src/main/java/dev/mflash/guides/springfox3/

public @SpringBootApplication class Launcher {

  public static void main(String[] args) {, args);

  public Docket docket() {
    return new Docket(DocumentationType.OAS_30)
        .apiInfo(new ApiInfoBuilder()
            .title("Note API")
            .description("A CRUD API to demonstrate Springfox 3 integration")
        .tags(new Tag("Note", "Endpoints for CRUD operations on notes"))

Launch the application and visit http://localhost:8080/swagger-ui/ where you'll see the documentation on the endpoints exposed by NoteController.

Swagger UI powered by Springfox 3
Swagger UI powered by Springfox 3

You can access the OpenAPI docs at http://localhost:8080/v3/api-docs which can be imported into compatible tools, like Postman, Insomnia, etc.


Source Codespringfox3-webmvc-integration