{"id":21105363,"url":"https://github.com/jliberma/restapi","last_synced_at":"2025-12-29T13:03:58.161Z","repository":{"id":88743758,"uuid":"90749099","full_name":"jliberma/restapi","owner":"jliberma","description":null,"archived":false,"fork":false,"pushed_at":"2017-05-16T20:44:08.000Z","size":142,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-14T08:45:33.128Z","etag":null,"topics":["flask","mongodb","python","rugby","rugby7s","tutorial"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jliberma.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-05-09T13:29:58.000Z","updated_at":"2017-05-16T20:45:47.000Z","dependencies_parsed_at":null,"dependency_job_id":"4bc00be8-3889-40b4-8c19-3ad13c4aa640","html_url":"https://github.com/jliberma/restapi","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/jliberma/restapi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jliberma%2Frestapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jliberma%2Frestapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jliberma%2Frestapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jliberma%2Frestapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jliberma","download_url":"https://codeload.github.com/jliberma/restapi/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jliberma%2Frestapi/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28116440,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-12-29T02:00:07.021Z","response_time":58,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["flask","mongodb","python","rugby","rugby7s","tutorial"],"created_at":"2024-11-20T00:05:23.542Z","updated_at":"2025-12-29T13:03:58.133Z","avatar_url":"https://github.com/jliberma.png","language":"Python","readme":"# restapi\n\nBackground:\n* [Designing a RESTful Web API](http://blog.luisrei.com/articles/rest.html) -- good high level resource (no pun intended)\n* [OpenStack SDKs](https://wiki.openstack.org/wiki/SDKs)\n* [Introduction to the OpenStack API](https://www.linux.com/learn/introduction-openstack-api)\n* [OpenStack Python SDK](https://docs.openstack.org/user-guide/sdk.html)\n* [API Creation](https://www.fullstackpython.com/api-creation.html) on Full Stack Python\n* [FlaskRESTful](https://flask-restful.readthedocs.io/en/0.3.5/) documentation\n* [RESTful Web API with Python, Flask and MongoDB](https://www.slideshare.net/slideshow/embed_code/13539139)\n\nTutorials:\n* [Django REST Framework Tutorial](http://www.django-rest-framework.org/tutorial/quickstart/)\n* [Implement RESTful API with Python and Flask](http://blog.luisrei.com/articles/flaskrest.html) -- [Example code](https://github.com/lrei/articles/tree/master/2012-05-02-flaskrest)\n* [Designing a RESTful API with Python and Flask](https://blog.miguelgrinberg.com/post/designing-a-restful-api-with-python-and-flask) -- [Github repo](https://github.com/miguelgrinberg/REST-tutorial)\n* [Designing a RESTful API using Flask-RESTful](https://blog.miguelgrinberg.com/post/designing-a-restful-api-using-flask-restful)\n* [REST API with Flask + MongoDB](http://www.bogotobogo.com/python/MongoDB_PyMongo/python_MongoDB_RESTAPI_with_Flask.php)\n* [Creating a REST Api using Flask-Restful and MongoDB](http://salmanwahed.github.io/2015/05/01/flask-restful-mongodb-api/)\n* [csvtojson Quick Start](https://www.npmjs.com/package/csvtojson#quick-start)\n* [csvkit](https://csvkit.readthedocs.io/en/1.0.2/index.html)\n\nEnvironment setup\n~~~~\n$ conda install --name py36 flask\n$ conda list -n py36\n# packages in environment at /Users/jacobliberman/miniconda2/envs/py36:\n#\naniso8601                 1.2.1                     \u003cpip\u003e\nclick                     6.7                      py36_0  \nflask                     0.12.1                   py36_0  \nFlask-HTTPAuth            3.2.2                     \u003cpip\u003e\nFlask-PyMongo             0.4.1                     \u003cpip\u003e\nFlask-RESTful             0.3.5                     \u003cpip\u003e\nitsdangerous              0.24                     py36_0  \njinja2                    2.9.6                    py36_0  \nmarkupsafe                0.23                     py36_2  \nmkl                       2017.0.1                      0  \nmongodb                   3.3.9                         0  \nnumpy                     1.12.1                   py36_0  \nopenssl                   1.0.2k                        1  \npep8                      1.7.0                    py36_0  \npip                       9.0.1                    py36_1  \npygame                    1.9.3                     \u003cpip\u003e\npymongo                   3.3.0                    py36_0  \npython                    3.6.1                         0  \npython-dateutil           2.6.0                     \u003cpip\u003e\npytz                      2017.2                    \u003cpip\u003e\nreadline                  6.2                           2  \nsetuptools                27.2.0                   py36_0  \nsix                       1.10.0                    \u003cpip\u003e\nsqlite                    3.13.0                        0  \ntk                        8.5.18                        0  \nwerkzeug                  0.12.1                   py36_0  \nwheel                     0.29.0                   py36_0  \nxz                        5.2.2                         1  \nzlib                      1.2.8                         3\n$ source activate py36\n$ python -V\nPython 3.6.1 :: Continuum Analytics, Inc.\n~~~~\n\n*Six Design Rules for a REST system*\n1. client-server\n2. stateless\n3. server indicates if requests are cacheable\n4. layered system -- intermediaries can respond instead of server without client interaction\n5. uniform interface\n6. optional -- servers can provide scripts or executables for clients to run in their context\n\nREST was originally designed to fit the HTTP protocol.\n\nIn REST resources are represented as URIs.\n\nDesigning a REST API is an exercise in identifying resources to expose and writing request methods to affect them.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjliberma%2Frestapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjliberma%2Frestapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjliberma%2Frestapi/lists"}