学习 Linux 下使用 Swagger(OpenAPI),可以按下面这条路线来,从基础到实战,比较清晰。
Swagger 是一套 API 描述与可视化工具,现在标准叫 OpenAPI。
常见组成部分:
# 查看系统
uname -a
# 安装基础工具
sudo apt update
sudo apt install -y curl wget git openjdk-11-jdk # Ubuntu/Debian
Swagger 很多工具用 Docker 最方便:
sudo apt install docker.io
sudo systemctl enable docker
docker run -p 8080:8080 \
-e SWAGGER_JSON=/foo/swagger.yaml \
-v $(pwd):/foo \
swaggerapi/swagger-ui
浏览器访问:
http://localhost:8080
新建 swagger.yaml:
openapi: 3.0.0
info:
title: 示例 API
version: 1.0.0
paths:
/hello:
get:
summary: 打招呼
responses:
'200':
description: 成功
content:
application/json:
schema:
type: object
properties:
msg:
type: string
用 Swagger UI 加载这个文件即可看到接口。
springfox / springdoc-openapi
依赖(Maven):
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
</dependency>
访问:
/swagger-ui.html
pip install fastapi uvicorn
FastAPI 自带 Swagger:
/docs
go install github.com/swaggo/swag/cmd/swag@latest
swag init
npm install -g swagger-cli
swagger-cli validate swagger.yaml
docker run -v $(pwd):/local openapitools/openapi-generator-cli
如果你愿意,可以告诉我:
我可以给你更具体的 Linux + Swagger 实战示例。