openapi

Remove default `application/json` header from fastapi response Question: I have taken this (https://fastapi.tiangolo.com/advanced/response-directly/#returning-a-custom-response) example from fastapi documentation regarding how to return a custom response from a fastapi application. This is my example code that i came up with to test it : from http.client import responses from fastapi import FastAPI, Response app = FastAPI() response_examples …

How to document default None/null in OpenAPI/Swagger using FastAPI? Question: Using a ORM, I want to do a POST request letting some fields with a null value, which will be translated in the database for the default value specified there. The problem is that OpenAPI (Swagger) docs, ignores the default None and still prompts a …

FastAPI – @Schema(hidden=True) not working when trying to hide the schema section on swagger docs Question: I’m trying to hide the entire schemas section of the FastAPI generated swagger docs. I’ve checked the docs and tried this but the schema section still shows. @Schema(hidden=True) class theSchema(BaseModel): category: str How do I omit one particular schema …

Insert local image in the FastAPI automatic documentation Question: Introduction FastAPI can autogenerate your documentation when you are using FastAPI to create an API. I am trying to insert an image in the description (markdown) of one of my endpoints, but I can’t do it when the image is located in the local hardrive. I …

Is it possible to run custom code before Swagger validations in a python/flask server stub? Question: I’m using the swagger editor (OpenApi 2) for creating flask apis in python. When you define a model in swagger and use it as a schema for the body of a request, swagger validates the body before handing the …

Swagger / OpenAPI spec featuring file upload rejected by Google Endpoints Question: My goal is to set up a simple API for uploading a file via Google Endpoints. This is my simplified OpenAPI specification which is valid according to Swagger validation: swagger: “2.0” info: title: “JSON Ingester” description: “Receive JSON files, transform and load them.” …