25.0118 (24.1213) Gdrive

The goal for this section is to discover/use tools that created some great API sites (such as nodejs docs).

1 Swagger / manual
2 Swagger / annotations
3 Swagger / autogen (from code)
4 REST other (Sphinx, markdown)
5 GraphQL
6 Socket.io, gRPC, websocket, etc
7 API websites
8 Swagger from AI
NOTES

1 Swagger / manual

24.1219 (1128,0922) Gdrive

~9 OK (working).

ASTRO

#242_(ERROR)_astro_swagger_GPT_v01_24.1210.docx (using GPT instructions, most works, but 404)

FLASK

Created working flask API/swag using manually created swag and swaggerhub server stubs (required many mods) #244_(OK)_api_tutorial_LENZO_v01_24.1211 Complete API Tutorial (from design to implementation with OpenAPI) Marco Lenzo https://www.youtube.com/watch?v=YJK03LdXwfQ

SWAGGER https://www.youtube.com/results?search_query=add+swagger+to+django+rest+framework

(22.06/GIT) (#114) 1_#114_(OK)_django_swagger_THEPYLOT_v01_24.1108.docx Swagger API documentation with Django REST Framework Developer Timeline https://www.youtube.com/watch?v=fbIFdWj8PsY&t=8s

NODEJS + express + swagger

1_#45_(OK)_(63.1)_nodejs_swagger_gpt_codemify_v01_24.0922.docx How to Create and Test API with Swagger Tutorial - For Dummies Codemify I used GPT (ChatGPT) to create NPM demos with Swagger. It worked great. Better than most tutorials. https://www.youtube.com/watch?v=4sR77vaEhy8
1_#210_(OK)_(61.2)_nodejs_express_api_swagger_TOFTGAARD_v02_24.1007.docx (COMPLETED 7/9 videos, video 9 implemented SWAGGER, start to finish) NodeJS Express API Project JacobToftgaard https://www.youtube.com/playlist?list=PLhzvYd8WG2OaLDeCmK1b87gowK7ZYxAgr Typescript site I built start to finish that included swagger built in.. everything worked, only required 2 days!
1_#205_(OK)_(62.X)_node_swagger_expressjs_FOSTER_v01_24.1005.docx Automatic Swagger Documentation with Node & Express Kris Foster https://www.youtube.com/watch?v=eiSem0cqaN0

FASTAPI:

1_#46_(OK)_(63.1)_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
1_#30_(OK)_(63.1)_FastAPI_Intro_Python_01_24.0918.docx FastAPI Introduction - Build Your First Web App - Python Tutorial Patrick Loeber https://www.youtube.com/watch?v=0RS9W8MtZe4
1_#27_(OK)_(63.1)_FastAPI_REST_API_15_Mins_v01_24.0916.docx Python FastAPI Tutorial: Build a REST API in 15 Minutes pixegami https://www.youtube.com/watch?v=iWS9ogMPOI0

2 Swagger / annotations

Swashbuckle, Nswag

1_#41_(OK)_(63.2)_swashbuckle_v07_24.0920.docx https://learn.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-swashbuckle
1_#42_(OK)_(63.7)_nswag_v07_24.0920.docx

3 Swagger / autogen (from code)

NSwag (RicoSuter): The Swagger/OpenAPI toolchain for .NET, ASP.NET Core and TypeScript

https://github.com/RicoSuter/NSwag

Features Generate Swagger 2.0 and OpenAPI 3.0 specifications from C# ASP.NET (Core) controllers Serve the specs via ASP.NET (Core) middleware, optionally with Swagger UI or ReDoc Generate C# or TypeScript clients/proxies from these specs Everything can be automated via CLI (distributed via NuGet tool or build target; or NPM) CLI configured via JSON file or NSwagStudio Windows UI Ways to use the toolchain Simple to use Windows GUI, NSwagStudio By using the OpenAPI or OpenAPI UI OWIN and ASP.NET Core Middlewares (also serves the Swagger UI) (recommended) Via command line (Windows, Mac and Linux support through Mono or .NET Core console binary, also via NPM package) In your C# code, via NuGet In your MSBuild targets With ServiceProjectReference tags in your .csproj (preview) In your Azure V2 Functions (external project, might not use latest NSwag version) Tutorials Add NSwag to your ASP.NET Core app Integrate the NSwag toolchain into your ASP.NET Web API project Generate an Angular TypeScript client from an existing ASP.NET Web API web assembly Video Tutorial: How to integrate NSwag into your ASP.NET Core Web API project (5 mins)

https://apimundo.com/

https://github.com/python-restx/flask-restx

Flask-RESTX is a community driven fork of Flask-RESTPlus.

Flask-RESTX is an extension for Flask that adds support for quickly building REST APIs. Flask-RESTX encourages best practices with minimal setup. If you are familiar with Flask, Flask-RESTX should be easy to pick up. It provides a coherent collection of decorators and tools to describe your API and expose its documentation properly using Swagger.

4 REST other (Sphinx)

#284_(OK-10%)_nodejs_doc_generate_NODEJS_v01_25.0110.docx Trying to generate the nosejs.org docs. generated basic pages.. need to get the frame and tailwind running.
#34_(OK)_(63.2b)_sphinx_tutorial_WSL_01_24.0920.docx 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.
#33_(OK)_(63.2b)_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
**** #31_(OK)_(63.2b)_zero2hero_sphinx_WSL_01_24.0919.docx (SERIES) zero 2 hero sphinx https://www.youtube.com/playlist?list=PLMQPLA3qF-uuD2p6s7qEjhIawm8pIqYr-
(19.07/GIT) #32_(ERROR)_(63.2b)_sphinx_avcourt_WSL_01_24.0919.docx https://www.youtube.com/watch?v=b4iFyrLQQh4

5 GraphQL

#262 graphql TRAVERSY

6 Socket.io, gRPC, websocket, etc

7 API websites

Looking for good websites to publish the (static) docs sites. Copy something someone else has done.

8 Swagger from AI

OpenAPI Specification Using ChatGPT | ChatGPT OpenAPI Specification | Create API Specs Using ChatGPT Tutorials Pedia https://www.youtube.com/watch?v=ataA0LDhZko

NOTES 25.0109

Tools and Integrations

https://swagger.io/tools/open-source/open-source-integrations/

2018 Annotation Libraries for Generating OAS (And Other FAQs from Swagger Users)

https://swagger.io/blog/api-development/swagger-annotation-libraries/

2018 Add Swagger to Your Existing APIs: How to Automate a "Code First" Approach to OAS at Scale

https://swagger.io/resources/webinars/automate-code-first-approach-swagger/

NOTES

TODO

1_#12_(JUNK??)_(63.2a.1)_microsoft (.NET+APIs+SwashbuckleNSwag)_v07_24.0920.docx
** FLASK (24.01,50mins) (PAYWALL... but good overview) 1_#29_(OK)_(63.1)_APIs_Flask_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)
1_#6_(TODO?)_(63.7)_C#_Http_Client_NSwag_Dunning_v04_24.0908.docx How to Generate C# Http Client in NSwag Swagger codegen Swashbuckle Logan Dunning
(TODO) (FASTAPI) Extending OpenAPI https://fastapi.tiangolo.com/how-to/extending-openapi/#the-normal-process
** (TODO) (19.03/GIT) Add Swagger UI to Python Flask API SBCODE https://www.youtube.com/watch?v=iZ2Tah3IxQc
**** (TODO) (23.05/GIT) How to Easily Create REST APIs with Flask-RESTX Pretty Printed https://www.youtube.com/watch?v=Qf0wri9MvMY
** (TODO) (23.01/GIT) Add Swagger to Flask API project with OpenAPI Vincent Stevenson https://www.youtube.com/watch?v=ayn-I9sV7BU

swagger manual

#244_(OK)_api_tutorial_LENZO_v01_24.1211.
- First 18 mins is creating swagger manually.
- He used codegen to generate python flask. I had errors... just used his code, but had to patch a lot.
- I added later to this demo
  - #240 django front end.