Skip to main content

Documenting REST API with Flask-Restx



This tutorial aims to use the Flask-restx library to implement and to document the REST API. Other similar libraries in the Flask framework include the flask_resful and  Flask-restplus libraries. 





The generated document is shown below.  All the operations are group into a default namespace. All the CRUD operations get, create, and update (except for the the delete operation) are displayed  below. 













Comments

Post a Comment

Popular posts from this blog

Web App Scaling with Flask Blueprint and Namespaces

A real-world Flask-RESTX-based API  may have multiple namespaces. The best practice for scaling a web application is to use a blueprint along with multiple namespace. The namespace is used to group a set of CRUD operations for a specific resource.  Blueprint can be used to combine (mixing) multiple namespaces. Here’s an example directory structure: project\ ├── app.py # Application file ├── apis #    ├── v20 # API directory    │   ├── __init__.py    │   ├── specs.py # API namespaces and REST methods    │   ├── steps.py # API namespaces and REST methods    └── v20bp.py # API blueprint file Here is an example app.py. Using a blue print allow you to mount your API on any url prefix. from flask import Flask from apis.v20bp import blueprint as api app = ...
Post a Comment
Read more

Display and Print Source Codes

One can use either "a2ps" or "trueprint" to print source codes. Today, I am going to experiment with "trueprint". A decent source code printing program should have the following requirements: Indentation is done correctly. Smart Spacing to avoid leaving out one-two lines of codes in previous page. Be able to convert to pdf or ps Be able to print two pages on one side The following are several examples of using the "trueprint" function: bash >> trueprint --portrait --language=cxx --intelligent-line-wrap --four-up --page-break-after-function --no-cover-sheet --output=EMMUtil_cpp.ps EMMUtil.cpp bash >> ps2pdf EMMUtil_cpp.ps EMMUtil_cpp.pdf bash >> rm EMMUtil_cpp.ps Please read the man page for further explanations. good day !!!
Post a Comment
Read more