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

IBM Watson Annotator for Clinical Data

IBM Watson Annotator for Clinical Data Is Now Generally Available on May 12, 2020  Explore healthcare insights from unstructured data with this new service on IBM Cloud. The practice of medicine is intertwined with patient data that allows doctors and nurses to diagnose illnesses. What symptoms does a patient have, and how does a healthcare worker describe a set of symptoms for others to treat? In today’s globalized world, the treatment can even be carried out by doctors and nurses on the other side of the globe. IBM Watson Annotator for Clinical Data —now generally available on IBM Cloud—delivers natural language processing (NLP) that is tailored for healthcare and life sciences and designed to enable organizations to utilize insights derived from unstructured text.  The medical domain NLP service features a variety of annotators for detecting metadata (such as entities, concepts, concept values, negated spans, hypothetical spans) and a...
1 comment
Read more