sanic-to-json 0.1.3

Create JSON API documentation files from Sanic

sanic-to-json

Generate a Postman JSON file from a Sanic app. The JSON file can directly uploaded into the Postman client or through their API.

Using the postman schema we can build Postman Collections using python endpoints from Sanic (Flask apps need testing). The script parses the Sanic app. It searches for blueprints. The blueprints, through routes, provide docs strings data. The doc string data is used to populate a Postman formatted JSON file. The JSON file can then be uploaded to Postman as a collection.

Once we have Postman formatted JSON we can create API documentation through the Postman API

How to use

• run generate_sanic_json("collection_name", app) Formats the Postman collection with 'collection_name' and doc strings from Sanic app, e.g., postman_collection.json

• to execute an example run python -m examples.example_script

How to document Sanic app and Blueprints

• As the example shows, the Sanic app should have a .doc attribute. This doc string will serve as the introduction to the API in Postman docs, e.g., app.__doc__ = "This API does stuff."

• Blueprints should also a doc string, this will serve as the description to each collection folder in Postman. Again see examples folder bp1.__doc__ = "This is the doc string for blueprint1."

How to install

pip install sanic-to-json

To do

• At the moment endpoints are assumed to accept raw JSON, as passed by the header option in sanic_to_json.atomic_requests

"header": [
            {
                "key": "Content-Type",
                "name": "Content-Type",
                "value": "application/json",
                "type": "text",
            }
          ]

Arguments to the header key could be passed in the doc strings, but I'll leave that for a future endevaor.

Contributors

See the GitHub contributor page

License

sanic-to-json is open source software licensed as MIT.