GitHub 代码仓Flutterando/shelf_swagger_ui

shelf_swagger_ui

Shelf 的 Swagger UI 插件

在 GitHub 查看 ↗

星标: 28
复刻: 5
最近推送（UTC）: 2025年6月13日
项目状态: 未归档

原始 README

以下为英文项目原文快照，最新内容请访问 GitHub。

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}');
}