FLUTTER ECOSYSTEM

Flutterando/shelf_swagger_ui

Shelf用のSwagger UIプラグイン

Stars: 28
Forks: 5
最終プッシュ（UTC）: 2025/06/13
プロジェクト状態: 公開中

GITHUB Organization

Flutterando ↗

The biggest and most active Flutter community in Latin America. Responsible for packages like flutter_modular and flutter_triple.

Brasil公式サイト ↗

言語Dart

技術トピック

# dart # shelf

このリポジトリが公開するパッケージ

v2.0.0

shelf_swagger_ui

Swagger + shelf を使用して洗練されたプロフェッショナルなドキュメントを提供します。

85いいね 161030日間ダウンロード145Pub ポイント

AndroidiOSmacOSWindowsLinux

使用している依存関係

依存関係一覧 5 件

http_parser>=4.0.0 <5.0.0
mime>=1.0.2 <2.0.0
path>=1.8.2 <2.0.0
shelf>=1.3.1 <2.0.0
yaml>=3.1.1 <4.0.0

元の README

以下は英語原文のスナップショットです。最新版は GitHub をご覧ください。

README を開く / 閉じる

Shelf SwaggerUI

Present, clean and professional documentation with Swagger + shelf; alt text

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!