https://github.com/0xtheprodev/fastapi-clean-example

Clean Architecture Example using FastAPI framework
https://github.com/0xtheprodev/fastapi-clean-example

clean-architecture fastapi graphql hexagonal-architecture openapi3 pydantic python python3 repository-pattern rest-api starlette strawberry-graphql swagger swagger-ui

Last synced: 16 days ago
JSON representation

Clean Architecture Example using FastAPI framework

• Host: GitHub
• URL: https://github.com/0xtheprodev/fastapi-clean-example
• Owner: 0xTheProDev
• License: mit
• Created: 2022-04-10T10:23:51.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-05-12T09:03:57.000Z (almost 2 years ago)
• Last Synced: 2025-03-29T18:06:17.594Z (23 days ago)
• Topics: clean-architecture, fastapi, graphql, hexagonal-architecture, openapi3, pydantic, python, python3, repository-pattern, rest-api, starlette, strawberry-graphql, swagger, swagger-ui
• Language: Python
• Homepage:
• Size: 101 KB
• Stars: 441
• Watchers: 5
• Forks: 58
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# fastapi-clean-example

[![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)](https://docs.python.org/3/)

[![FastAPI](https://img.shields.io/badge/FastAPI-005571?style=for-the-badge&logo=fastapi)](https://fastapi.tiangolo.com/)

[![OpenAPI](https://img.shields.io/badge/openapi-6BA539?style=for-the-badge&logo=openapi-initiative&logoColor=fff)](https://www.openapis.org/)

[![Swagger](https://img.shields.io/badge/-Swagger-%23Clojure?style=for-the-badge&logo=swagger&logoColor=white)](https://swagger.io/)

[![GraphQL](https://img.shields.io/badge/-GraphQL-E10098?style=for-the-badge&logo=graphql&logoColor=white)](https://graphql.org/)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge)](https://black.readthedocs.io/en/stable/)

[![Typed with: pydantic](https://img.shields.io/badge/typed%20with-pydantic-BA600F.svg?style=for-the-badge)](https://docs.pydantic.dev/)

[![Open Issues](https://img.shields.io/github/issues-raw/0xTheProDev/fastapi-clean-example?style=for-the-badge)](https://github.com/0xTheProDev/fastapi-clean-example/issues)

[![Closed Issues](https://img.shields.io/github/issues-closed-raw/0xTheProDev/fastapi-clean-example?style=for-the-badge)](https://github.com/0xTheProDev/fastapi-clean-example/issues?q=is%3Aissue+is%3Aclosed)

[![Open Pulls](https://img.shields.io/github/issues-pr-raw/0xTheProDev/fastapi-clean-example?style=for-the-badge)](https://github.com/0xTheProDev/fastapi-clean-example/pulls)

[![Closed Pulls](https://img.shields.io/github/issues-pr-closed-raw/0xTheProDev/fastapi-clean-example?style=for-the-badge)](https://github.com/0xTheProDev/fastapi-clean-example/pulls?q=is%3Apr+is%3Aclosed)

[![Contributors](https://img.shields.io/github/contributors/0xTheProDev/fastapi-clean-example?style=for-the-badge)](https://github.com/0xTheProDev/fastapi-clean-example/graphs/contributors)

[![Activity](https://img.shields.io/github/last-commit/0xTheProDev/fastapi-clean-example?style=for-the-badge&label=most%20recent%20activity)](https://github.com/0xTheProDev/fastapi-clean-example/pulse)

## Description

_Example Application Interface using FastAPI framework in Python 3_

This example showcases Repository Pattern in Hexagonal Architecture _(also known as Clean Architecture)_. Here we have two Entities - Books and Authors, whose relationships have been exploited to create CRUD endpoint in REST under OpenAPI standard.

## Installation

- Install all the project dependency using [Pipenv](https://pipenv.pypa.io):

  ```sh

  $ pipenv install --dev

  ```

- Run the application from command prompt:

  ```sh

  $ pipenv run uvicorn main:app --reload

  ```

- You can also open a shell inside virtual environment:

  ```sh

  $ pipenv shell

  ```

- Open `localhost:8000/docs` for API Documentation

- Open `localhost:8000/graphql` for GraphQL Documentation

_*Note:* In case you are not able to access `pipenv` from you `PATH` locations, replace all instances of `pipenv` with `python3 -m pipenv`._

## Testing

For Testing, `unittest` module is used for Test Suite and Assertion, whereas `pytest` is being used for Test Runner and Coverage Reporter.

- Run the following command to initiate test:

  ```sh

  $ pipenv run pytest

  ```

- To include Coverage Reporting as well:

  ```sh

  $ pipenv run pytest --cov-report xml --cov .

  ```

## License

© MIT License