Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature] Add argument to disable FastAPI docs #2540

Merged
merged 1 commit into from
Oct 8, 2024

Conversation

mouweng
Copy link
Contributor

@mouweng mouweng commented Sep 30, 2024

Thanks for your contribution and we appreciate it a lot. The following instructions would make your pull request more healthy and more easily receiving feedbacks. If you do not understand some items, don't worry, just make the pull request and seek help from maintainers.

Motivation

This PR is to add a new argument option to disable the /, /openapi.json, /redoc and /docs/oauth2-redirect. My company doesn't allow using such endpoints in production environments. A new argument is added to disable the endpoint

reference doc: https://fastapi.tiangolo.com/tutorial/metadata/

Modification

Add argument --disable-fastapi-docs

BC-breaking (Optional)

N/A

Use cases (Optional)

lmdeploy serve api_server facebook/opt-125m --disable-fastapi-docs
  • Before
    开启文档

  • After
    关闭文档

Checklist

  1. Pre-commit or other linting tools are used to fix the potential lint issues.
  2. The modification is covered by complete unit tests. If not, please add more unit tests to ensure the correctness.
  3. If the modification has a dependency on downstream projects of a newer version, this PR should be tested with all supported versions of downstream projects.
  4. The documentation has been modified accordingly, like docstring or example tutorials.

@mouweng mouweng changed the title Add argument to disable FastAPI docs [Feature] Add argument to disable FastAPI docs Sep 30, 2024
@lvhan028 lvhan028 requested a review from AllentDan October 7, 2024 13:56
@@ -45,7 +45,7 @@ class VariableInterface:
api_server_url: Optional[str] = None


app = FastAPI(docs_url='/')
router = APIRouter()
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the purpose of using router?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because the original app = FastAPI(docs_url='/') was defined globally, I needed to control the availability of the documentation using the disable_fastapi_docs parameter passed into the serve function.

I moved the initialization of app = FastAPI(...) into the main function. The endpoints, such as '/v1/chat/completions', are registered through router, and finally, I use app.include_router(router) to included the router.

Copy link
Collaborator

@AllentDan AllentDan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@lvhan028 lvhan028 merged commit 6f34738 into InternLM:main Oct 8, 2024
4 of 5 checks passed
yao-fengchen pushed a commit to DeepLink-org/lmdeploy that referenced this pull request Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants