Help us understand the problem. What is going on with this article?

Spring Boot で実装した REST API に swagger-ui を導入する


  • Spring Boot で REST API を実装している前提
  • API のドキュメントを生成する swagger-ui を導入する
  • gradle に io.springfox:springfox-boot-starter:3.0.0 を追加するだけ


  • Spring Initializr で Spring Web を選択してプロジェクト新規作成
  • REST API を実装
    • src\main\java\com\example\demo\api\ を以下内容で作成
package com.example.demo.api;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.Map;

public class DemoController {

    public String[] customers() {
        return new String[] {

    public Map<String, String> customer(@PathVariable String id) {
        return Map.of(
                "id", id,
                "name", "名前",
                "address", "東京都");

swagger-ui 導入

  • build.gradle に追加
    implementation "io.springfox:springfox-boot-starter:3.0.0"


モード1(守りのIT)・モード2(攻めのIT)を兼ね備えたバイモーダル・インテグレーターとしてデータ連携プラットフォームのHULFTシリーズ, リンケージサービス, 流通ITサービス, フィナンシャルITサービスを提供します。
Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away