Fetch error internal server error openapi json - Исправление ошибок и поиск оптимальных решений проблем

I’m new to FastAPI and was making spectacular progress integrating Stripe, CouchDB, and even SendGrid. Then, out of the blue, «Failed to load API definition. Fetch error Internal Server Error /openapi.json» comes up on /docs Even rolling back to previous versions doesn’t change things.

FastAPI is running but the /docs is dead and I don’t know where to go next. Google searches give confusing advice for this novice.

The code is here: https://github.com/agropper/T2FastAPI

The Terminal output is:

(venv) MacBookPro:T2FastAPI adrian$ python main.py
INFO: Uvicorn running on http://0.0.0.0:8081 (Press CTRL+C to quit)
INFO: Started reloader process [1363] using statreload
INFO: Started server process [1365]
INFO: Waiting for application startup.
INFO: Application startup complete.
INFO: 127.0.0.1:49873 — «GET / HTTP/1.1» 200 OK
INFO: 127.0.0.1:49873 — «GET /favicon.ico HTTP/1.1» 404 Not Found
INFO: 127.0.0.1:49876 — «GET /docs HTTP/1.1» 200 OK
INFO: 127.0.0.1:49876 — «GET /openapi.json HTTP/1.1» 500 Internal Server Error
ERROR: Exception in ASGI application
Traceback (most recent call last):
File «/Users/adrian/Documents/GitHub/T2FastAPI/venv/lib/python3.9/site-packages/uvicorn/protocols/http/h11_impl.py», line 396, in run_asgi
result = await app(self.scope, self.receive, self.send)
File «/Users/adrian/Documents/GitHub/T2FastAPI/venv/lib/python3.9/site-packages/uvicorn/middleware/proxy_headers.py», line 45, in call
return await self.app(scope, receive, send)
File «/Users/adrian/Documents/GitHub/T2FastAPI/venv/lib/python3.9/site-packages/fastapi/applications.py», line 199, in call
await super().call(scope, receive, send)
File «/Users/adrian/Documents/GitHub/T2FastAPI/venv/lib/python3.9/site-packages/starlette/applications.py», line 112, in call
await self.middleware_stack(scope, receive, send)
File «/Users/adrian/Documents/GitHub/T2FastAPI/venv/lib/python3.9/site-packages/starlette/middleware/errors.py», line 181, in call
raise exc from None
File «/Users/adrian/Documents/GitHub/T2FastAPI/venv/lib/python3.9/site-packages/starlette/middleware/errors.py», line 159, in call
await self.app(scope, receive, _send)
File «/Users/adrian/Documents/GitHub/T2FastAPI/venv/lib/python3.9/site-packages/starlette/exceptions.py», line 82, in call
raise exc from None
File «/Users/adrian/Documents/GitHub/T2FastAPI/venv/lib/python3.9/site-packages/starlette/exceptions.py», line 71, in call
await self.app(scope, receive, sender)
File «/Users/adrian/Documents/GitHub/T2FastAPI/venv/lib/python3.9/site-packages/starlette/routing.py», line 580, in call
await route.handle(scope, receive, send)
File «/Users/adrian/Documents/GitHub/T2FastAPI/venv/lib/python3.9/site-packages/starlette/routing.py», line 241, in handle
await self.app(scope, receive, send)
File «/Users/adrian/Documents/GitHub/T2FastAPI/venv/lib/python3.9/site-packages/starlette/routing.py», line 52, in app
response = await func(request)
File «/Users/adrian/Documents/GitHub/T2FastAPI/venv/lib/python3.9/site-packages/fastapi/applications.py», line 152, in openapi
return JSONResponse(self.openapi())
File «/Users/adrian/Documents/GitHub/T2FastAPI/venv/lib/python3.9/site-packages/fastapi/applications.py», line 130, in openapi
self.openapi_schema = get_openapi(
File «/Users/adrian/Documents/GitHub/T2FastAPI/venv/lib/python3.9/site-packages/fastapi/openapi/utils.py», line 368, in get_openapi
result = get_openapi_path(route=route, model_name_map=model_name_map)
File «/Users/adrian/Documents/GitHub/T2FastAPI/venv/lib/python3.9/site-packages/fastapi/openapi/utils.py», line 194, in get_openapi_path
operation_parameters = get_openapi_operation_parameters(
File «/Users/adrian/Documents/GitHub/T2FastAPI/venv/lib/python3.9/site-packages/fastapi/openapi/utils.py», line 98, in get_openapi_operation_parameters
«schema»: field_schema(
File «pydantic/schema.py», line 234, in pydantic.schema.field_schema
File «pydantic/schema.py», line 202, in pydantic.schema.get_field_info_schema
File «pydantic/schema.py», line 899, in pydantic.schema.encode_default
File «pydantic/json.py», line 95, in pydantic.json.pydantic_encoder
TypeError: Object of type ‘type’ is not JSON serializable

Источник

Содержание

How to debug Fastapi openapi generation error
Failed to load API definition. Fetch error Internal Server Error /openapi.json — don’t know where to start #3328
Comments
[QUESTION] #319
Comments
[BUG] OpenAPI fails when forcing query params to be body and multiple params in each #284
Comments
/openapi.json «HTTP Error 500» when a response_class Union is used. #2082
Comments
First check
Example
Description
Environment
Additional context

How to debug Fastapi openapi generation error

I spend some time going over this error but had no success.

File «C:Usersebara.condaenvsascilibsite-packagesfastapiopenapiutils.py», line 388, in get_openapi flat_models=flat_models, model_name_map=model_name_map

File «C:Usersebara.condaenvsascilibsite-packagesfastapiutils.py», line 28, in get_model_definitions model_name = model_name_map[model]

The problem is that I’m trying to build a project with user authentication from OpenAPI form to create new users in database.

Everything works except for Authentication like here.

When I add this part form_data: OAuth2PasswordRequestForm = Depends() — and go to /docs page — this error appears (Failed to load API definition. Fetch error. Internal Server Error /openapi.json)

The server itself runs in normal mode, but it can’t load the open API. If I remove the aforementioned formdata part — then everything works smoothly, but without Authorisation. I tried to debug it, but I have no success. I think it might be connected to a dependency graph or some start-up issues, but have no guess how to trace it back.

Here is the full working example which will reproduce the error. The link points out the code which causes the problem. If you will comment out lines 18-39 — the docs will open without any problems. https://github.com/BEEugene/fastapi_error_demo/blob/master/fastapi_service/api/api_v1/endpoints/login.py

Any ideas on how to debug or why this error happens?

Источник

Failed to load API definition. Fetch error Internal Server Error /openapi.json — don’t know where to start #3328

FastAPI is running but the /docs is dead and I don’t know where to go next. Google searches give confusing advice for this novice.

The Terminal output is:

The text was updated successfully, but these errors were encountered:

Источник

[QUESTION] #319

Description

FastAPI doc does not show structure of response (I’m using Pydantic).

I am working on porting an API to FastAPI. I have FastAPI and pydantic working nicely on my system. I import my pydantic models in a file called models.py, if that makes a difference, they’re not directly in main. I like this organization. Much of the work for the endpoints themselves are done in a library file I call opasAPISupportLib.py which needs those too. In the main file, I don’t need to do a lot for an endpoint, here’s one:

I have finshed three endpoints and they don’t show the response structure in the doc page with either the Swagger based doc or ReDoc.

Here’s the relevant models for this endpoint from models.py:

I expected to see a sample json structure in the Responses 200 area. Nowhere in the doc as generated in either docs generator does it show the json return structure for API users. I would have expected to see something like this;

Additional context
I’ve seen online examples which also have blank areas for responses, for code 200. Shouldn’t it show the response model somewhere?

The text was updated successfully, but these errors were encountered:

You need to declare it in the decorator:

Thanks. I missed that! And that «sort of» works. But that’s not really the response_model. The real response model is:

But specifying that gives:

The decorator you specified works, but it’s not the whole response, ResponseInfo is a substructure (see the model in my post). The hierarchy is:

and ResponseInfo is just the information header, and the real data is in List[AuthorIndexItem]

An example return json response is this:

(I haven’t suppled the publications URL field mapping yet)

So it looks like a bug or design issue? It doesn’t seem to support nested json structures?

Or am I missing something else?

ETA: If I put the lower level model in the decorator, the docs works and shows the lower model. but the API stops working (probably due to validation of the actual response). So I can’t even show the lower item in the doc with this technique.

@nrshapiro There should be no problems with nested json structures, and I don’t see anything obvious about your use case that should be preventing you from getting this to work. Since you are getting an internal server error (and it’s while generating the schema), it’s probably not just a validation issue.

Could you share the error traceback you are getting when you try to access the docs with response_model=models.AuthorIndex ?

If you have trouble getting the traceback, try setting debug=True when you create the app:

I started uvicorn with —debug too. Here’s the log:

@nrshapiro I think I found your problem. Here’s your code:

The annotation on responseInfo seems wrong; I think it should be

or similar. In particular, what comes after the colon (and before = ) should be a type, not an instance.

After making that change, I was able to generate the swagger docs without an error (I created the ListTypeEnum as an Enum with just «authorindex» as the only key).

I’m not sure I understand your goals here, but it seems like this might not be accomplishing what you intend — you’d probably want to set the listType somewhere else when instantiating what is going to go into the responseInfo . (I don’t think there is a way to modify the default arguments within an annotation, if that’s your goal.)

If I’m understanding correctly, I’d probably just go with responseInfo: ResponseInfo as the annotation here.

Nailed it! Thank you! I’m so glad it was just my error, because now it works properly!

Sorry to take your time, but I’ve only been working with FastAPI and Pydantic for a few days!

Источник

[BUG] OpenAPI fails when forcing query params to be body and multiple params in each #284

Describe the bug

The OpenAPI spec for my app breaks with the following error (shown in my web browser).

This only happens when I have endpoints defined in two separate files, each of which force all their arguments to be body parameters via annotating each parameter with Body(. ) to force them to be body parameters, as opposed to query parameters.

If the endpoints are defined in the same file, then the problem does not happen.
If each endpoint only has a single parameter, the problem does not happen.
If only one endpoint has multiple parameters, then the problem does not happen.

It only happens when both endpoints have multiple parameters annotated with Body(. ) .

To Reproduce

Steps to reproduce the behavior:

Create a directory with the following structure.

foo/baz.py (identical to foo/bar.py)

Run with uvicorn main:app —reload
Visit http://localhost:8000/docs

Expected behavior

The OpenAPI page shows without error.

Screenshots

Here’s the exception my app produces when I try to visit http://localhost:8000 .

Environment:

OS: [e.g. macOS]
FastAPI Version [e.g. 0.27.0], get it with pip install fastapi .

Additional context

When I only have a single endpoint, the value of model_name_map is < : ‘Body_compute’>.
However, when I have both endpoints take multiple parameters, the value of model_name_map is < : ‘None__Body_compute’>.

The text was updated successfully, but these errors were encountered:

Источник

/openapi.json «HTTP Error 500» when a response_class Union is used. #2082

First check

I added a very descriptive title to this issue.
I used the GitHub search to find a similar issue and didn’t find it.
I searched the FastAPI documentation, with the integrated search.
I already searched in Google «How to X in FastAPI» and didn’t find any information.
I already read and followed all the tutorial in the docs and didn’t find an answer.
I already checked if it is not related to FastAPI but to Pydantic.
I already checked if it is not related to FastAPI but to Swagger UI. (Happens before this is relevant)
I already checked if it is not related to FastAPI but to ReDoc. (Happens before this is relevant)
After submitting this, I commit to one of:
- Read open issues with questions until I find 2 issues where I can help someone and add a comment to help there.
- I already hit the «watch» button in this repository to receive notifications and I commit to help at least 2 people that ask questions in the future.
- Implement a Pull Request for a confirmed bug.

Example

Here’s a self-contained example with my use case:

Description

When open the browser and call the endpoint /docs or /redoc , I get on redoc a:

And on /docs I get a:

But works as expected when I use curl:
curl -X GET «http://127.0.0.1:8000/items/sdfghj6ty» -H «accept: text/plain
or
curl -X GET «http://127.0.0.1:8000/items/sdfghj6ty» -H «accept: application/json»

If I have a Union with only one element in, the error do not occur.
I have not found anywhere how to have multiple response_classes, but it is in the cards that Union is used for this. (Let me know if I am wrong.)

Environment

[FEATURE] ending / for collections #51 -Ubuntu SMP Fri Sep 4 19:50:52 UTC 2020 x86_64 GNU/Linux

FastAPI Version: 0.61.0

Python Version: 3.8.2

Additional context

The text was updated successfully, but these errors were encountered:

Источник

I was working with some ASP.NET WebApi code and needed to test something using the Swagger UI. Usually, it’s just a matter of starting the project and going to your /swagger directory. Unfortunately, in this case, I went to my swagger URL and got an error saying “Failed to load API definition — Fetch error — Internal Server Error /swagger/v1/swagger.json.” How do you fix this error?

The Swagger UI error

I knew that it used to work but I’d just updated about a half zillion things in my code including upgrading to .NET Core 5 so I wasn’t really sure what broke it. I assumed the worst.

The dev tools in Edge was showing me that it was trying to access swagger.json but it was getting an HTTP 500 error. My guess was that I had a configuration problem in Startup.cs and that the swagger.json file either wasn’t being generated or it was in the wrong place. I checked a bunch of stuff and didn’t find anything.

The call to get swagger.json was returning HTTP 500

I eventually started to figure out what was going wrong when I opened that call to swagger.json in its own tab.

The error message on that HTTP 500 to swagger.json

The actual error message says that there’s an “ambiguous HTTP method for action”. I wasn’t really sure what that meant by helpfully the error message pointed me at the WebApi endpoint action that was causing the problem. Rather than being a problem with some kind of swagger config, the error was coming from the code that I’d just been working on.

Swashbuckle.AspNetCore.SwaggerGen.SwaggerGeneratorException: Ambiguous HTTP method for action - SwaggerError.WebApi.Controllers.WeatherForecastController.Overview (SwaggerError.WebApi). Actions require an explicit HttpMethod binding for Swagger/OpenAPI 3.0
   at Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenerator.GenerateOperations(IEnumerable`1 apiDescriptions, SchemaRepository schemaRepository)
   at Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenerator.GeneratePaths(IEnumerable`1 apiDescriptions, SchemaRepository schemaRepository)
   at Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenerator.GetSwagger(String documentName, String host, String basePath)
   at Swashbuckle.AspNetCore.Swagger.SwaggerMiddleware.Invoke(HttpContext httpContext, ISwaggerProvider swaggerProvider)
   at Microsoft.AspNetCore.Diagnostics.DeveloperExceptionPageMiddleware.Invoke(HttpContext context)

Here’s the code that’s causing the problem:

[ApiController]
[Route("[controller]")]
public class WeatherForecastController : ControllerBase
{
    [Route("/[controller]/[action]/{id}")]
    public ActionResult Overview(int? id)
    {
        return Ok(id);
    }
}

Looks pretty ordinary, right? Nothing to exciting here. So what’s broken? What’s “ambiguous” about this? It’s missing the HttpGet attribute.

[ApiController]
[Route("[controller]")]
public class WeatherForecastController : ControllerBase
{
    [HttpGet]
    [Route("/[controller]/[action]/{id}")]
    public ActionResult Overview(int? id)
    {
        return Ok(id);
    }
}

As soon as I added that missing [HttpGet] attribute, the Swagger UI was working again.

Summary

In short, the problem was a problem in my code. I’d assumed that my WebApi controller action would default to HTTP GET but it seems that that doesn’t agree with Swagger. As soon as I added that missing attribute, everything was fine.

I hope this helps.

-Ben

— Looking for help on your .NET Core projects? Want some guidance on how to get going with Azure DevOps or GitHub Actions? Need a Scrum coach to help your teams get over a delivery slump? We can help. Drop us a line at info@benday.com.

Источник

INFO:     127.0.0.1:55111 - "GET / HTTP/1.1" 200 OK
INFO:     127.0.0.1:52235 - "GET /docs HTTP/1.1" 200 OK
INFO:     127.0.0.1:52235 - "GET /openapi.json HTTP/1.1" 500 Internal Server Error
ERROR:    Exception in ASGI application
Traceback (most recent call last):
  File "C:UsersmeAnaconda3libsite-packagesuvicornprotocolshttph11_impl.py", line 373, in run_asgi
    result = await app(self.scope, self.receive, self.send)
  File "C:UsersmeAnaconda3libsite-packagesuvicornmiddlewareproxy_headers.py", line 75, in __call__
    return await self.app(scope, receive, send)
  File "C:UsersmeAnaconda3libsite-packagesfastapiapplications.py", line 210, in __call__
    await super().__call__(scope, receive, send)  # pragma: no cover
  File "C:UsersmeAnaconda3libsite-packagesstarletteapplications.py", line 112, in __call__
    await self.middleware_stack(scope, receive, send)
  File "C:UsersmeAnaconda3libsite-packagesstarlettemiddlewareerrors.py", line 181, in __call__
    raise exc from None
  File "C:UsersmeAnaconda3libsite-packagesstarlettemiddlewareerrors.py", line 159, in __call__
    await self.app(scope, receive, _send)
  File "C:UsersmeAnaconda3libsite-packagesstarletteexceptions.py", line 82, in __call__
    raise exc from None
  File "C:UsersmeAnaconda3libsite-packagesstarletteexceptions.py", line 71, in __call__
    await self.app(scope, receive, sender)
  File "C:UsersmeAnaconda3libsite-packagesstarletterouting.py", line 580, in __call__
    await route.handle(scope, receive, send)
  File "C:UsersmeAnaconda3libsite-packagesstarletterouting.py", line 241, in handle
    await self.app(scope, receive, send)
  File "C:UsersmeAnaconda3libsite-packagesstarletterouting.py", line 52, in app
    response = await func(request)
  File "C:UsersmeAnaconda3libsite-packagesfastapiapplications.py", line 161, in openapi
    return JSONResponse(self.openapi())
  File "C:UsersmeAnaconda3libsite-packagesfastapiapplications.py", line 146, in openapi
    servers=self.servers,
  File "C:UsersmeAnaconda3libsite-packagesfastapiopenapiutils.py", line 388, in get_openapi
    flat_models=flat_models, model_name_map=model_name_map
  File "C:UsersmeAnaconda3libsite-packagesfastapiutils.py", line 25, in get_model_definitions
    model, model_name_map=model_name_map, ref_prefix=REF_PREFIX
  File "pydanticschema.py", line 548, in pydantic.schema.model_process_schema
  File "pydanticschema.py", line 589, in pydantic.schema.model_type_schema
  File "pydanticschema.py", line 241, in pydantic.schema.field_schema
  File "pydanticschema.py", line 495, in pydantic.schema.field_type_schema
  File "pydanticschema.py", line 863, in pydantic.schema.field_singleton_schema
ValueError: Value not declarable with JSON Schema, field: name='Fuel_Type_Petrol' type=Optional[object] required=True

I am new to FastAPI, and I came across this error and don’t know how to deal with it. Please, help me solve this.

Источник

Swagger or OpenAPI describes standards and specifications for the RESTFul API description. These specifications are an attempt to create a universal and language agnostic description for describing the REST API.

Benefits of Open API specification :

The open specification provides the advantage of understanding the RESTFul services easily (especially if developers are consuming any new Web API ) plus
Helps provide easy ready documentation saving time
It provides details of the capabilities the service owns.
Serve the Swagger UI to browse and test the web API.
Client-side SDK generation
Helps in API discovery.

Fixing Failed to load API Definition

When working with some ASP.NET WebApi code and needed to test something using Swagger UI, you might find this error “Failed to load API definition — Fetch error — Internal Server Error /swagger/v1/swagger.json.” You can see the image below:

I knew that it used to work but I’d just updated about a half zillion things in my code including upgrading to .NET Core 5 so I wasn’t really sure what broke it. I assumed the worst.

The call to get swagger.json was returning HTTP 500.

I eventually started to figure out what was going wrong when I opened that call to swagger.json in its own tab.

Swashbuckle.AspNetCore.SwaggerGen.SwaggerGeneratorException: Ambiguous HTTP method for action - 
SwaggerError.WebApi.Controllers.WeatherForecastController.Overview (SwaggerError.WebApi). Actions require an explicit 
HttpMethod binding for Swagger/OpenAPI 3.0 at Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenerator.GenerateOperations
(IEnumerable`1 apiDescriptions, SchemaRepository schemaRepository) at 
Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenerator.GeneratePaths(IEnumerable`1 apiDescriptions, SchemaRepository
schemaRepository) at Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenerator.GetSwagger(String documentName, String host, String
basePath) at Swashbuckle.AspNetCore.Swagger.SwaggerMiddleware.Invoke(HttpContext httpContext, ISwaggerProvider 
swaggerProvider) at Microsoft.AspNetCore.Diagnostics.DeveloperExceptionPageMiddleware.Invoke(HttpContext context)

Here’s the code that’s causing the problem:

[ApiController]
[Route("[controller]")]
public class WeatherForecastController : ControllerBase
{
    [Route("/[controller]/[action]/{id}")]
    public ActionResult Overview(int? id)
    {
        return Ok(id);
    }
}

Looks pretty ordinary, right? Nothing to exciting here. So what’s broken? What’s “ambiguous” about this? It’s missing the HttpGet attribute.

[ApiController]
[Route("[controller]")]
public class WeatherForecastController : ControllerBase
{
    [HttpGet]
    [Route("/[controller]/[action]/{id}")]
    public ActionResult Overview(int? id)
    {
        return Ok(id);
    }
}

As soon as I added that missing [HttpGet] attribute, the Swagger UI was working again.

Summary

I hope this helps.

Andriy Kravets is writer and experience .NET developer and like .NET for regular development. He likes to build cross-platform libraries/software with .NET.

Источник

[BUG] Error generating OpenAPI with generated scheme #548

Comments

i8enn commented Sep 19, 2019 •

I apologize in advance for my «English»

When trying to see «swagger» when the server is running without «—reload» parameter, an error appears «Fetch error: Internal Server Error /openapi.json»

It appears only if the documentation contains generated schemes (for example, single parameter with embed=True (as in the example below), or OAuth2PasswordRequestForm dependency).

If you add the option “—reload” to the uvicorn server launch command, the error disappears.

Endpoint view function:

Response model scheme:

Environment:
Docker: 19.03.2, build 6a30dfc
Docker-compose: 1.23.1, build b02f1306
Used docker image: python:3.7-alpine
Python: 3.7.4
FastAPI: 0.38.0

P.S.: I understand that perhaps the swagger is not needed in the production version, but the presence of “—reload” in the docker in any version of the image, except for the development version, in my opinion is bad.

Thank you in advance!

The text was updated successfully, but these errors were encountered:

zamiramir commented Sep 20, 2019

Could you post your response model code? (AuthTokens)

i8enn commented Sep 20, 2019

@zamiramir, yes of course. Added to issue description.

tiangolo commented Feb 10, 2020

@i8enn it’s a bit difficult to guess what might be happening in your use case without being able to run the code.

Please, check the tutorial and make sure that everything is working correctly for you: https://fastapi.tiangolo.com/tutorial/security/ . Follow it as is, and see if it works as expected, that should let you see if the error is related to your current environment.

If that doesn’t help you find the issue, then please create a minimal self-contained app in a single script that shows the error. That way we can run it and check it.

i8enn commented Feb 10, 2020

@tiangolo, okay, thanks. I’m check this during this week and I will say about the results.

xgenvn commented Feb 22, 2020

I can reproduce with a simple endpoint that following the tutorial

xgenvn commented Feb 22, 2020 •

Also, simple case described in docs:

I also tested with single param as well:

However, the error happens when I start debugging with uvicon import:

Start will fail using module option:

If I start the app using uvicorn from command line, with or without reload —reload , it does just fine:

This is quite frustrating, since I rely OpenAPI UI to debug some simple tests.

i8enn commented Feb 25, 2020 •

@tiangolo hello! I apologize for the late answer.

Unfortunately, now I have to work a lot on project with «Django» and the development of an application that is written using «FastAPI» is now suspended.

But how godlike it is — working with FastAPI. Thank you very much for this beautiful framework!

In turned out to be on simple examples that it could not be reproduced, and therefore I had to reproduce a more similar my real project application structure and launch mechanisms.

I created a repository so that can conveniently deploy it locally.
This is done in haste, so some things may seem unnecessary as part of a this small example

In my application, I redefined the «uvicorn» launch command (unfortunately, I can’t remember why now).

Perhaps it’s because of launch of the application using «click» and calling the application initialization function in command function.

By the way, it seems I found another bug related to the generation of the circuit (it does not find routes). While this is not accurate — tomorrow I will check again and talk about the results.

Источник

/openapi.json «HTTP Error 500» when a response_class Union is used. #2082

Comments

tacozMacleo commented Sep 21, 2020 •

First check

I added a very descriptive title to this issue.
I used the GitHub search to find a similar issue and didn’t find it.
I searched the FastAPI documentation, with the integrated search.
I already searched in Google «How to X in FastAPI» and didn’t find any information.
I already read and followed all the tutorial in the docs and didn’t find an answer.
I already checked if it is not related to FastAPI but to Pydantic.
I already checked if it is not related to FastAPI but to Swagger UI. (Happens before this is relevant)
I already checked if it is not related to FastAPI but to ReDoc. (Happens before this is relevant)
After submitting this, I commit to one of:
- Read open issues with questions until I find 2 issues where I can help someone and add a comment to help there.
- I already hit the «watch» button in this repository to receive notifications and I commit to help at least 2 people that ask questions in the future.
- Implement a Pull Request for a confirmed bug.

Example

Here’s a self-contained example with my use case:

Description

When open the browser and call the endpoint /docs or /redoc , I get on redoc a:

And on /docs I get a:

Environment

[FEATURE] ending / for collections #51 -Ubuntu SMP Fri Sep 4 19:50:52 UTC 2020 x86_64 GNU/Linux

FastAPI Version: 0.61.0

Python Version: 3.8.2

Additional context

The text was updated successfully, but these errors were encountered:

Источник

WebApi Core / Swagger: “failed to load API definition” error

The Swagger UI error

I knew that it used to work but I’d just updated about a half zillion things in my code including upgrading to .NET Core 5 so I wasn’t really sure what broke it. I assumed the worst.

The call to get swagger.json was returning HTTP 500

I eventually started to figure out what was going wrong when I opened that call to swagger.json in its own tab.

The error message on that HTTP 500 to swagger.json

Here’s the code that’s causing the problem:

Looks pretty ordinary, right? Nothing to exciting here. So what’s broken? What’s “ambiguous” about this? It’s missing the HttpGet attribute.

As soon as I added that missing [HttpGet] attribute, the Swagger UI was working again.

Summary

Источник

Failed to load API definition. Fetch error Internal Server Error /openapi.json — don’t know where to start #3328

Comments

agropper commented Jun 4, 2021

FastAPI is running but the /docs is dead and I don’t know where to go next. Google searches give confusing advice for this novice.

The Terminal output is:

The text was updated successfully, but these errors were encountered:

Источник

[BUG] OpenAPI fails when forcing query params to be body and multiple params in each #284

Comments

ebanner commented Jun 3, 2019

Describe the bug

The OpenAPI spec for my app breaks with the following error (shown in my web browser).

If the endpoints are defined in the same file, then the problem does not happen.
If each endpoint only has a single parameter, the problem does not happen.
If only one endpoint has multiple parameters, then the problem does not happen.

It only happens when both endpoints have multiple parameters annotated with Body(. ) .

To Reproduce

Steps to reproduce the behavior:

Create a directory with the following structure.

foo/baz.py (identical to foo/bar.py)

Run with uvicorn main:app —reload
Visit http://localhost:8000/docs

Expected behavior

The OpenAPI page shows without error.

Screenshots

Here’s the exception my app produces when I try to visit http://localhost:8000 .

Environment:

OS: [e.g. macOS]
FastAPI Version [e.g. 0.27.0], get it with pip install fastapi .

Additional context

When I only have a single endpoint, the value of model_name_map is < : ‘Body_compute’>.
However, when I have both endpoints take multiple parameters, the value of model_name_map is < : ‘None__Body_compute’>.

The text was updated successfully, but these errors were encountered:

Источник

How to debug Fastapi openapi generation error

Failed to load API definition. Fetch error Internal Server Error /openapi.json — don’t know where to start #3328

[QUESTION] #319

[BUG] OpenAPI fails when forcing query params to be body and multiple params in each #284

/openapi.json «HTTP Error 500» when a response_class Union is used. #2082

First check

Example

Description

Environment

Additional context

Summary

Benefits of Open API specification :

Fixing Failed to load API Definition

Summary

[BUG] Error generating OpenAPI with generated scheme #548

Comments

i8enn commented Sep 19, 2019 •

zamiramir commented Sep 20, 2019

i8enn commented Sep 20, 2019

tiangolo commented Feb 10, 2020

i8enn commented Feb 10, 2020

xgenvn commented Feb 22, 2020

xgenvn commented Feb 22, 2020 •

i8enn commented Feb 25, 2020 •

/openapi.json «HTTP Error 500» when a response_class Union is used. #2082

Comments

tacozMacleo commented Sep 21, 2020 •

First check

Example

Description

Environment

Additional context

WebApi Core / Swagger: “failed to load API definition” error

Summary

Failed to load API definition. Fetch error Internal Server Error /openapi.json — don’t know where to start #3328

Comments

agropper commented Jun 4, 2021

[BUG] OpenAPI fails when forcing query params to be body and multiple params in each #284

Comments

ebanner commented Jun 3, 2019

Читайте также: