https://github.com/overtrue/openapi-yaml-to-html

https://github.com/overtrue/openapi-yaml-to-html

Last synced: 6 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/overtrue/openapi-yaml-to-html
• Owner: overtrue
• Created: 2024-11-14T10:42:30.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-11-14T11:06:37.000Z (about 1 year ago)
• Last Synced: 2025-03-09T18:46:05.916Z (10 months ago)
• Language: HTML
• Size: 246 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# OpenAPI yaml to html

openapi to yaml 是一个 oci 插件，用于将 openapi yaml 文件转换为 html 文件。

## 使用

流水线配置示例：

```yaml

  - name: 渲染 API 文档

    image: overtrue/openapi-yaml-to-html:1.0.5

    settings:

      input: ./docs/api.yaml        # openapi yaml 文件路径

      output: ./public/docs.html    # 可选，html 文件输出路径，默认为 ./api.html

      title: API 文档                # 可选，默认「OpenAPI」

      template: elements   #  可选，模板，swagger(默认)/elements/redoc

```