gitmyhub

apistar

Python ★ 5.5k updated 4y ago ▣ archived

The Web API toolkit. 🛠

API Star is a Python command-line toolkit for OpenAPI and Swagger schemas: validate your API description for errors, spin up a local documentation site, and send API requests by operation name from the terminal.

PythonOpenAPISwaggerYAMLsetup: easycomplexity 2/5

API Star is a Python toolkit built around OpenAPI and Swagger schemas. OpenAPI is a standard format for describing how a web API works, including what endpoints exist, what parameters they accept, and what responses to expect. The toolkit reads those description files and uses them to do three things: build developer documentation with a built-in web server, check the schema file for mistakes and report specific errors, and send API requests by referencing the operations defined in the schema.

To get started, you install it with Python's package manager and point it at a schema file. A small YAML configuration file tells it where your schema lives and what format it uses. From there, a single command validates the schema and reports any problems, another command spins up a documentation site you can browse in a browser, and a third lets you call specific API operations from the command line by name, passing parameters as key-value pairs.

The project changed direction starting with version 0.6. Before that, API Star included a full web server framework for building APIs. That server component was removed, and the project now focuses entirely on tooling: documentation, validation, and client-side requests. If you have existing code depending on the older server behavior, the 0.5 branch is still on GitHub and installable from the Python package index.

API Star requires Python 3.6 or newer and is released under the BSD license, a permissive open-source license that allows use in commercial projects. The README makes clear that this toolkit is for working with API description files, not for serving a web application. It does not cover advanced configuration or plugin details beyond the basic workflow described above.

Where it fits