在 Ubuntu 上使用 Swagger,通常有两种常见场景:
下面按常见用法一步步说明(以 Ubuntu 20.04 / 22.04 为例)。
sudo apt update
sudo apt install docker.io -y
sudo systemctl enable --now docker
docker run -p 8080:8080 -e SWAGGER_JSON=/foo/swagger.json -v $PWD:/foo swaggerapi/swagger-ui
浏览器打开:
http://localhost:8080
把
swagger.json放到当前目录即可。
sudo apt install nodejs npm -y
npm install -g swagger-ui-cli
swagger-ui-cli serve swagger.json
docker run -p 8081:8080 swaggerapi/swagger-editor
访问:
http://localhost:8081
sudo apt install default-jre -y
wget https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.35/swagger-codegen-cli-3.0.35.jar
java -jar swagger-codegen-cli-3.0.35.jar generate \
-i swagger.yaml \
-l spring \
-o ./generated-api
支持语言:
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>2.3.0</version>
</dependency>
启动后访问:
http://localhost:8080/swagger-ui.html
swagger.json(Swagger 2.0)openapi.yaml(OpenAPI 3.0,推荐)示例:
openapi: 3.0.0
info:
title: User API
version: 1.0.0
paths:
/users:
get:
summary: 获取用户列表
responses:
'200':
description: OK
我可以给你 更精确的 Ubuntu 使用教程。