Skip to main content

Swagger integration for viewing REST on your guillotina install

Project description

A guillotina application to automatically generate swagger interfaces for APIs defined with guillotina.

Configuration

Available config.json options:

{
    "swagger": {
        "authentication_allowed": false,
        "base_configuration": {
            "swagger": "2.0",
            "info": {
                "version": "",
                "title": "Guillotina",
                "description": "The REST Resource API"
            },
            "host": "",
            "basePath": "",
            "schemes": [],
            "produces": [
                "application/json"
            ],
            "consumes": [
                "application/json"
            ],
            "paths": {},
            "definitions": {}
        }
    }
}

Viewing swagger for resource

Append @docs onto any url: http://localhost:8080/@docs.

1.0.4 (2017-06-13)

  • Use vhm for host setting on swagger [vangheem]

1.0.3 (2017-06-13)

  • Pay attention to vhm

1.0.2 (2017-06-12)

  • be able to provide custom base_url for swagger [vangheem]

1.0.1 (2017-06-07)

  • Fix getting path of resource

1.0.0 (2017-04-04)

  • initial release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

guillotina_swagger-1.0.4.tar.gz (1.0 MB view hashes)

Uploaded Source

Built Distribution

guillotina_swagger-1.0.4-py3-none-any.whl (1.1 MB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page