Fastapi: Update JWT docs with python-jose

Created on 19 Jun 2020  路  2Comments  路  Source: tiangolo/fastapi

First check

  • [x] I added a very descriptive title to this issue.
  • [x] I used the GitHub search to find a similar issue and didn't find it.
  • [x] I searched the FastAPI documentation, with the integrated search.
  • [x] I already searched in Google "How to X in FastAPI" and didn't find any information.
  • [x] I already read and followed all the tutorial in the docs and didn't find an answer.
  • [x] I already checked if it is not related to FastAPI but to Pydantic.
  • [x] I already checked if it is not related to FastAPI but to Swagger UI.
  • [x] I already checked if it is not related to FastAPI but to ReDoc.
  • [x] After submitting this, I commit to:

    • Read open issues with questions until I find 2 issues where I can help someone and add a comment to help there.

    • Or, 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

N/A, docs.

Description

The docs should suggest and use https://github.com/mpdavis/python-jose instead of PyJWT as python-jose supports the same features plus some more that are required for some OAuth2 use cases.

The solution you would like

I would like all the docs that deal with security with JWT to suggest and https://github.com/mpdavis/python-jose instead of PyJWT.

Describe alternatives you've considered

To leave it as is, but I'm already using python-jose everywhere and is what I would recommend.

Environment

  • OS: [e.g. Linux / Windows / macOS]: All
  • FastAPI Version [e.g. 0.3.0]: All

To know the FastAPI version use:

python -c "import fastapi; print(fastapi.__version__)"
  • Python version: All

To know the Python version use:

python --version

Additional context

confirmed docs enhancement good first issue

Most helpful comment

@tiangolo, I will be working on this issue.

All 2 comments

@tiangolo, I will be working on this issue.

Thanks @asheux for your work on this! :rocket:

Was this page helpful?
0 / 5 - 0 ratings