学习 Linux 下的 Swagger(通常指 OpenAPI 生态,如 Swagger UI、Swagger Editor、Swagger Codegen / OpenAPI Generator 等),可以按下面路线系统学习。
Swagger 是一套 REST API 描述、调试、文档化 的工具集,现在更规范的说法是 OpenAPI。
常见组件:
# 常用工具
sudo apt update
sudo apt install -y curl wget git openjdk-17-jdk docker.io
docker run -p 8080:8080 \
-e SWAGGER_JSON=/foo/swagger.yaml \
-v $PWD:/foo \
swaggerapi/swagger-ui
浏览器访问:
http://localhost:8080
docker run -p 8081:8080 swaggerapi/swagger-editor
示例 swagger.yaml:
openapi: 3.0.0
info:
title: User API
version: 1.0.0
paths:
/users:
get:
summary: 获取用户列表
responses:
'200':
description: 成功
学习重点:
pathsparametersrequestBodyresponsescomponents / schemas<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>2.3.0</version>
</dependency>
访问:
http://localhost:8080/swagger-ui.html
java -jar swagger-codegen-cli.jar generate \
-i swagger.yaml \
-l java \
-o ./out
docker run openapitools/openapi-generator-cli generate \
-i swagger.yaml -g python -o ./client
如果你愿意,可以告诉我:
我可以给你更针对性的 Linux + Swagger 实战示例。