shelf_swagger_ui's Introduction

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(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!

shelf_swagger_ui's People

Contributors

Stargazers

Watchers

shelf_swagger_ui's Issues

add angel framework integration

It would be interesting if the swagger_ui somehow had integration with angel framework to allow the automatic generation of documentation for a rest API, at the moment I'm using and mitmproxy and mitmproxy2swagger to generate documentation automatically

https://github.com/alufers/mitmproxy2swagger#mitmproxy
https://mitmproxy.org

https://github.com/dukefirehawk/angel

APIs not getting listed in pipelined router

I already have a my shelf Router router with multiple routes. I tried to cascade SwaggerUI as handler. However, none of my API routes are getting listed in swagger UI. Please assist. The documentation provided does not cover such scenarios

    var staticHandler =
        createStaticHandler('wwwroot', defaultDocument: 'index.html');
    return Pipeline()
        .addMiddleware(corsHeaders())
        //.addHandler(router);
        .addHandler(Cascade()
            .add(router)
            .add(staticHandler)
            .add(SwaggerUI('wwwroot/swagger.yaml',
                title: 'MyApp API Doc'))
            .handler);

openapi: 3.0.0
info:
  description: "API Test"
  version: "1.0.0"
  title: "MyApp API"
servers:
  - url: http://localhost:8080
    description: "MyApp Server"
tags:
  - name: "/api/users"
    description: "User resource"

Recommend Projects