13、Swagger API 文档搭建与多环境部署指南

Swagger API 文档搭建与多环境部署指南

1. Swagger 简介

Swagger 现称为 OpenAPI 规范，是用于描述、生成、使用、测试和可视化 RESTful API 的规范。它附带了许多工具，可根据给定的端点自动生成文档。本文重点介绍其中一个工具——Swagger UI，用于构建客户端 API 文档。如果你对 Swagger 还不熟悉，可查看官方文档中的 “What Is Swagger?” 指南。

2. 新服务设置

2.1 创建目录与 Dockerfile

在 “services” 目录下创建一个名为 “swagger” 的新目录，并添加一个 Dockerfile-dev 文件，用于从 Docker Hub 拉取基础 Nginx 镜像，安装 Swagger UI，更新 Nginx，然后运行 start.sh 。以下是 Dockerfile-dev 的内容：

FROM nginx:1.13.8
ENV SWAGGER_UI_VERSION 3.9.3
ENV URL **None**
RUN apt-get update \
    && apt-get install -y curl \
    && curl -L https://github.com/swagger-api/swagger-ui/archive/v${SWAGGER_UI_VERSION}.tar.gz | tar -zxv -C /tmp \