https://github.com/Flutterando/shelf_swagger_ui

Swagger UI plugin for Shelf
https://github.com/Flutterando/shelf_swagger_ui

dart shelf

Last synced: about 2 months ago
JSON representation

Swagger UI plugin for Shelf

• Host: GitHub
• URL: https://github.com/Flutterando/shelf_swagger_ui
• Owner: Flutterando
• License: other
• Created: 2022-07-04T01:11:07.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-07-11T01:20:52.000Z (about 2 years ago)
• Last Synced: 2024-07-09T00:04:38.709Z (2 months ago)
• Topics: dart, shelf
• Language: Dart
• Homepage: https://pub.dev/packages/shelf_swagger_ui
• Size: 136 KB
• Stars: 22
• Watchers: 7
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Shelf SwaggerUI

Present, clean and professional documentation with Swagger + shelf;

![alt text](https://raw.githubusercontent.com/Flutterando/shelf_swagger_ui/main/example.png)

## Example

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

```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:

```dart

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

import 'package:shelf_swagger_ui/shelf_swagger_ui.dart';

void main(List args) async {

  final path = 'specs/swagger.yaml';

  final handler = SwaggerUI(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!