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\DemoController.java を以下内容で作成
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;
@RestController
@RequestMapping("/api/demo")
public class DemoController {
@GetMapping("/customers")
public String[] customers() {
return new String[] {
"あいうえお",
"かきくけこ",
"さしすせそ"
};
}
@GetMapping("/customer/{id}")
public Map<String, String> customer(@PathVariable String id) {
return Map.of(
"id", id,
"name", "名前",
"address", "東京都");
}
}
swagger-ui 導入
- build.gradle に追加
build.gradle
implementation "io.springfox:springfox-boot-starter:3.0.0"
- アプリケーション起動
-
http://localhost:8080/swagger-ui/ をブラウザで開く
参考
io.springfox:springfox-boot-starter:3.0.0
を追加するだけ- Spring Initializr で Spring Web を選択してプロジェクト新規作成
- REST API を実装
- src\main\java\com\example\demo\api\DemoController.java を以下内容で作成
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;
@RestController
@RequestMapping("/api/demo")
public class DemoController {
@GetMapping("/customers")
public String[] customers() {
return new String[] {
"あいうえお",
"かきくけこ",
"さしすせそ"
};
}
@GetMapping("/customer/{id}")
public Map<String, String> customer(@PathVariable String id) {
return Map.of(
"id", id,
"name", "名前",
"address", "東京都");
}
}
swagger-ui 導入
- build.gradle に追加
build.gradle
implementation "io.springfox:springfox-boot-starter:3.0.0"
- アプリケーション起動
-
http://localhost:8080/swagger-ui/ をブラウザで開く
参考
build.gradle
implementation "io.springfox:springfox-boot-starter:3.0.0"
Author And Source
この問題について(Spring Boot で実装した REST API に swagger-ui を導入する), 我々は、より多くの情報をここで見つけました https://qiita.com/Yoshihiro-Hirose/items/b96a0de3258481b16281著者帰属:元の著者の情報は、元のURLに含まれています。著作権は原作者に属する。
Content is automatically searched and collected through network algorithms . If there is a violation . Please contact us . We will adjust (correct author information ,or delete content ) as soon as possible .