Git Product home page Git Product logo

api-pattern's Introduction

Introduction

This Template API was created to help new developers to create a new APIs easily and with a pattern requested by the company

CreatedBy: Douglas Buss Ronchi
CreationDate: 2022/04
CreaterEmail:
Credits:

Getting Started

1. Installation process

  • Clone this repo
  • Run pip install -r requirements/dev.txt command
  • Create a .env file with the environment variables like .env.example
  • Run nerdctl compose up -d command
  • Start run.py file.
  • It runs an uvicorn server at 127.0.0.1:8000
  • Acess the docs from 127.0.0.1:8000/docs

2. Software dependencies

  • MongoDB

3. Project requirements

Dev

  • pytest==7.1.1
  • pytest-cov==3.0.0
  • pytest-mock==3.7.0
  • pyclean==2.2.0
  • mongomock==4.0.0

App

  • httpie==3.1.0
  • pydantic==1.9.0
  • mongoengine==0.24.1
  • loguru==0.6.0
  • fastapi==0.75.1
  • starlette==0.17.1
  • requests==2.27.1
  • PyJWT==2.3.0
  • uvicorn==0.17.6
  • pymongo==4.1.1

4. Latest releases

  • v1.0.0 - First Release

5. API references

  • FastAPI

Build and Test

To run the tests just follow the steps:

  • Run pip install -r requirements/test.txt command
  • Run pytest command

Contribute

Feel free to contribute, just make a new branch from main branch, make the changes and open a new pull request.

api-pattern's People

Contributors

douglasronchi avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.