Skip to main content

Set up a modern REST API by running one command.

Project description

FastApi Gen

Create FastAPI apps with no build configuration.

FastApi Gen works on macOS and Linux.
If something doesn’t work, please file an issue.

Available templates:

  1. Default - basic template with GET/POST examples.
  2. More to come!

Quick Overview

pip install fastapi-gen
fastapi-gen my_app
cd my_app
make start-dev

or

pipx fastapi-gen my_app
cd my_app
make start-dev

If you've previously installed fastapi-gen globally via pip install fastapi-gen, we recommend you reinstall the package using pip install fastapi-gen or pipx upgrade fastapi-gen to ensure that you use the latest version.

Then open http://localhost:8000/docs to see your app OpenAPI documentation.

Get Started Immediately

You don’t need to install or configure depencendeices like FastApi or Pytest.
They are preconfigured and hidden so that you can focus on the code.

Create a project, and you’re good to go.

Creating an App

You’ll need to have Python 3.7+ or later version on your local development machine. We recommend using the latest LTS version. You can use pyenv (macOS/Linux) to switch Python versions between different projects.

basic template

pip install fastapi-gen
fastapi-gen my_app

or

pip install fastapi-gen 
fastapi-gen my_app --template hello_world

Inside the newly created project, you can run some built-in commands:

make start

Runs the app in development mode.
Open http://localhost:8000/docs to view OpenAPI documentation in the browser.

The page will automatically reload if you make changes to the code.

make test

Runs tests.
By default, runs tests related to files changed since the last commit.

License

fastapi-gen is distributed under the terms of the MIT license.

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

fastapi_gen-0.1.0.tar.gz (7.4 kB view hashes)

Uploaded Source

Built Distribution

fastapi_gen-0.1.0-py3-none-any.whl (9.5 kB 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