# pecan-swagger

**Repository Path**: dev-99cloud/pecan-swagger

## Basic Information

- **Project Name**: pecan-swagger
- **Description**: Fork from https://github.com/elmiko/pecan-swagger. The original website is out of day, however pecan-swagger is valueable, so let's continue. :-)
- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 6
- **Created**: 2022-03-10
- **Last Updated**: 2025-04-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Pecan Swagger

## 1. 项目背景

Pecan-Swagger 用于为 Pecan Web 服务生成 Swagger 文档。该项目源自 <https://github.com/elmiko/pecan-swagger>，目前原 repo 已无人维护，[原示例链接](examples/README.rst)。

Pecan 是 OpenStack 诸多模块中比较受欢迎的一种 Restful API 框架，新兴的项目大多采用 Pecan，比如 Magnum / CloudKitty 等等。Pecan-Swagger 依然是有很大价值的，因此我们再这个 repo 继续更新 Pecan-Swagger。

## 2. 需要预先掌握的技能

1. [Python 三日课程](https://gitee.com/wu-wen-xiang/training-python/blob/master/doc/learning-python-in-3-days.md)
2. [Git 基本使用](https://gitee.com/wu-wen-xiang/training-python/blob/master/doc/learning-python-in-3-days.md#31-%E7%89%88%E6%9C%AC%E6%8E%A7%E5%88%B6)
3. [Markdown 基本语法](https://markdown.com.cn/basic-syntax/)
4. [Gitee 合作](https://gitee.com/help/articles/4346)
5. [Swagger](https://editor.swagger.io/)

## 3. 预期目标

1. 对接 Pecan 最近的 Stable 版本，提供 Pecan-Swagger 模块，为 Pecan 项目提供在线的 Swagger 文档。