CatchTheTornado / CatchTheTornado/text-extract-api

[feat] Redirect / to docs page

Open
#81 0 comments 0 reactions 0 assignees View on GitHub
feature
Dominant language
Python
Stars
3.2k
Forks
279
PR merge metrics
No merged PRs in 30d

Description

@ngpollock the reason for the "not found" errors is that you're trying to access localhost:8000/, but currently, there's nothing running on that endpoint (/.

You should use the endpoints provided in the documentation, like /ocr/request

https://github.com/CatchTheTornado/text-extract-api
![image](https://github.com/user-attachments/assets/68cc1ce1-faa2-4258-a4bb-d455f9a161f1)

@pkarw this leads me to consider that it might be worth route / to docs page, or if its not easy in FastAPI then do redirect from / to docs ;)

_Originally posted by @choinek in https://github.com/CatchTheTornado/text-extract-api/discussions/78#discussioncomment-11821392_

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the FastAPI application entry point and the existing root route, then check how the documentation endpoint is configured. Done means requesting / redirects to the docs page without changing the documented API endpoints.

Written by the indexing model from the issue text.

Assessment

Tech stack
fastapi, python
Domain
api
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.