shelf_swagger_ui

套件介紹

根據套件公開資料產生的選型評估，僅供參考。

Shelf_Swagger_UI 是一個 Flutter/Dart 套件，將 Swagger UI 與 Shelf 網頁伺服器框架整合，讓開發者能夠產生並提供乾淨、互動式的 API 文件。它簡化了使用專業且使用者友善介面展示符合 OpenAPI 標準的 API 的過程。此套件非常適合使用 Shelf 建構的後端服務，可在瀏覽器中直接實時探索 API。支援從 OpenAPI 規範動態呈現文件，方便團隊間維護與分享 API 合約。

適用情境

提供互動式 API 文件
基於文件架的 REST API
啟用即時 API 測試
與後端開發工作流程整合
支援團隊協作進行API設計

主要特色

與 Shelf 的無縫整合
動態 Swagger UI 渲染
支援 OpenAPI 規範
基於瀏覽器的互動式文件
輕鬆設定，設定最少

適合對象

使用 Shelf 的後端開發人員
需要 API 文件的團隊
具有 OpenAPI 兼容 API 的專案
需要即時 API 預覽的開發環境
基於 Flutter 的後端服務

使用建議

需要貨架伺服器設定
不適用於前端使用
如果 API 發生變更，必須手動更新文件
超出 Swagger UI 預設設定的自訂功能有限
最適合開發和預發佈環境，不建議在生產環境中部署，除非採取安全措施

原始 README

以下為關聯原始碼儲存庫的 README 原文快照，最新內容請造訪原始碼儲存庫。

Shelf SwaggerUI

Present, clean and professional documentation with Swagger + shelf;

Example

Get a YAML or JSON schema file. Ex: (specs/swagger.yaml)

openapi: 3.0.0
info:
  description: "API system"
  version: "1.0.10"
  title: "Swagger Test"
servers:
  - url: http://my-service.info
    description: Remote server
tags:
- name: "user"
  description: "Access to User"

Configure the handler with Shelf:

import 'package:shelf/shelf_io.dart' as io;
import 'package:shelf_swagger_ui/shelf_swagger_ui.dart';

void main(List<String> args) async {
  final path = 'specs/swagger.yaml';
  final handler = SwaggerUI.fromFile(File(path), title: 'Swagger Test');
  var server = await io.serve(handler, '0.0.0.0', 4001);
  print('Serving at http://${server.address.host}:${server.port}');
}

That`s it!

搜尋套件、儲存庫與 APP 分類

安裝套件