italomaia/flask-empty

Create API example

italomaia opened this issue · 7 comments

italomaia commented

Right now we have a blog example using sqlalchemy. It would be nice to have a full API example using good practices (OpenAPI, Swagger, Rest).

Apoorva-13 commented

Hi
I would like to contribute to this, can you please describe more precisely as to what has to be done, I am new to python

italomaia-bk commented

Sure thing @Apoorva-13 Thanks for your interest! Gonna get a proper description for this by the end of the day (GMT+2)

  • 👍1
italomaia commented

So @Apoorva-13 flask empty has a examples folder with a blog example. The idea is to have another example app made with flask empty there that uses a different set of functionality provided by the boilerplate. In this case, it would be an API example.
This example should be different from the blog example that is already there and should use the extensions suggested by flask-empty during the creation step (marshmallow, etc). After reading the docs of the extensions already provided, I would also suggest that you use any other packages you believe could make this example more interesting, like swagger for automatic api documentation.

So, these are the requirements:

  • the example should be a good use case for an api
  • should show authentication and permissioning usage
  • should use the extensions suggested by flask-empty where possible (other extensions can be added)
  • should implement parameter validation
  • should have tests
  • should have an readme explaining what was done and what is required to run it
  • should be clear (PEP8) and commented

As you say you're new to python, I would like to know if you're also new to web development. If the answer is yes to this question, this issue might be quite challenging for you. I don't say it to desmotivate you, but to have you aware of the degree of commitment you might have to put on this.

In case of any other questions, please, let me know.

vinimmelo commented

Maybe i can help in this issue, good practice for me, since i develop web applications in Flask.

  • 👍1
italomaia-bk commented

Let me know if you need help @vinimmelo

  • 👍1
  • 🚀1
Amn04 commented

If no one is assigned or working on this issue then @italomaia @italomaia-bk Can you please assign this to me.
Thanks

italomaia commented

@Amn04 Go for it!