shelf_swagger_ui

插件介绍

基于插件公开信息、社区数据与项目使用情况整理的选型参考。

Shelf_Swagger_UI 是一个 Flutter/Dart 包，将 Swagger UI 与 Shelf Web 服务器框架集成，使开发者能够生成并提供简洁、交互式的 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 分类

安装插件