Skip to content

robertonscjr/djinns

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Djinns ジン

Djinss is a tool in which you specify your API and, magically, you can go straight to implementing the business logic for your endpoints.

This might be useful for you because you can save time with coding and documentation as the API is specified.

This project is a wrapper out of the Flask that has automations for code and docs generation.

Quickstart

  1. Change the api_spec.json and the apis/ folder with the definition of the endpoints/paths of your API.
  2. Create your application code and invoke the Djinns as explained in the snippet below.
from djinns.main import Djinns


djinns = Djinns(apispec_file="api_spec.json")
djinns.invoke()

Obs: You can change the entrypoint.py code with your own procedure. The changes will be applied to all endpoints, like provides a database object for API controller functions.

TODO

  1. Implement documentation generation from api_spec.json file.
  2. Add module to pypi

About

Djinns: Generates boilerplate of code, documentation and test from an API specification written in JSON.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages