63.0a Demos - terrytaylorbonn/auxdrone GitHub Wiki

63.0a Demos 24.0925

All docs referenced on this page available on Gdrive.

The following are the (basic) demos I've gotten to work so far (its a start). I am in the "window shopping phase, experimenting with and documenting any promising API doc tools I can find. Later I will write getting started and conceptual guides based on the best tools.

63.1 API only

Part 63.1 contains demos of API creation with NO API docs. Knowing how to create basic APIs is important for creating API docs.

FLASK NO SWAGGER

(OK) *63.3a_#21_(3.0)_flask_rest_api_tutorial_DaveGray_v02_24.0811_0903_0916.docx
(OK) 63.1_#24_Python_REST_API_Tutorial-Building_a_Flask_REST_API_Tech_With_Tim_v01_24.0915.docx // youtube.com/watch?v=GMppyAPbLYk 20.07, 70mins, sqlalchemy db, copilot guessed much of it
(OK) 63.1_#4_Create_A_Python_API_in_12_Minutes_Tech_With_Tim_v01_24.0915.docx

63.2a API + (built-in) doc

FASTAPI + SWAGGER

(OK) 63.1a_#30_FastAPI_Introduction_Build_Your_First_Web_App_Python_Tutorial_01_24.0918.docx FastAPI Introduction - Build Your First Web App - Python Tutorial Patrick Loeber https://www.youtube.com/watch?v=0RS9W8MtZe4
(OK) 63.1_#27_Python_FastAPI_Tutorial_Build_a_REST_API_in_15_Minutes_v01_24.0916.docx Python FastAPI Tutorial: Build a REST API in 15 Minutes pixegami https://www.youtube.com/watch?v=iWS9ogMPOI0

FLASK + SWAGGER

(OK) (24.01,50mins) (PAYWALL... but good overview) 63.1_#29_Build_APIs_with_Flask_the_right_way_02_24.0918.docx Build APIs with Flask (the right way) microapis https://www.youtube.com/watch?v=mt-0F_5KvQw (NOTE: PUT at the end of demo returned 500.. otherwise all OK)

SWASHBUCKLE (C#)

(OK) 63.2a.1_#41_swashbuckle_v07_24.0920.docx

63.2b Doc only

SPHINX

(OK) 63.2b_#34_sphinx_tutorial_WSL_01_24.0920.docx, This is the sphinx website tutorial.. still need to finish. The author for some reason leaves out little critical details left and right, so will take some time. but basically works. WSL win11.
(OK) (GIT) 63.2b_#33_sphinx_soumil_WSL_01_24.0919.docx Sphinx Documentation Tool | HTML UI | How to Document Large Python Codebases and Classes | Soumil Shah https://www.youtube.com/watch?v=5s3JvVqwESA
(OK) (WSL) 63.2b_#31_zero2hero_sphinx_WSL_01_24.0919.docx zero 2 hero sphinx https://www.youtube.com/playlist?list=PLMQPLA3qF-uuD2p6s7qEjhIawm8pIqYr-

63.3 GraphQL

63.4 Test (Postman)

63.5 Doc only deploy

Deploy = API doc available at URL.

(OK) 63.5__#51_nodejs_swagger_to_aws_v01_24.0924.docx, deployed swagger (in nodejs) to aws elastic beanstalk.
(OK) 63.5__#50_swagger_to_gitbook_v01_24.0923.docx, deployed swagger to gitbook.
(OK) 63.5__#49_swagger_to_railway_v01_24.0923.docx, deployed swagger to https://swaggerrailway-production.up.railway.app/api-docs/ .

63.6 API deploy (maybe + built-in doc)

(OK)("90%")(AZURE) 63.5__#53_nodejs_swagger_to_azure_v02_24.0925.docx (my test deployment on azure)
(OK)(AWS) 63.1__#46_fastapi_ec2_pixegami_v01_24.0922.docx How to Deploy FastAPI on AWS EC2: Quick and Easy Steps! pixegami https://www.youtube.com/watch?v=SgSnz7kW-Ko