Refactor the /auth to /authorize

Author: ArtyomVancyan

docs/integration/integration.md

@@ -50,8 +50,8 @@ choices, this kind of solution gives developers freedom.
 ## Router
 
 Router defines the endpoints that are used for the authentication and logout. The authentication is done by
-the `/oauth2/{provider}/auth` endpoint and the logout is done by the `/oauth2/logout` endpoint. The `{provider}` is the
-name of the provider that is going to be used for the authentication and coincides with the `name` attribute of
+the `/oauth2/{provider}/authorize` endpoint and the logout is done by the `/oauth2/logout` endpoint. The `{provider}` is
+the name of the provider that is going to be used for the authentication and coincides with the `name` attribute of
 the `backend` provided to the certain `OAuth2Client`.
 
 ```python

docs/references/index.md

@@ -22,7 +22,7 @@ the [#19](https://github.com/pysnippet/fastapi-oauth2/issues/19) issue.
 
 ## CSRF protection
 
-CSRF protection is enabled by default which means when the user opens the `/oauth2/{provider}/auth` endpoint it
+CSRF protection is enabled by default which means when the user opens the `/oauth2/{provider}/authorize` endpoint it
 redirects to the authorization endpoint of the IDP with an autogenerated `state` parameter and saves it in the session
 storage. After authorization, when the `/oauth2/{provider}/token` callback endpoint gets called with the
 provided `state`, the `oauthlib` validates it and then redirects to the `redirect_uri`.

docs/references/tutorials.md

@@ -22,7 +22,7 @@ generated the client ID and secret to configure your `OAuth2Middleware` with at
 3. Set the `redirect_uri` of your application that you have also configured in the IDP.
 4. Add the middleware and include the router to your application as shown in the [integration](/integration/integration)
    section.
-5. Open the `/oauth2/{provider}/auth` endpoint on your browser and test the authentication flow. Check out
+5. Open the `/oauth2/{provider}/authorize` endpoint on your browser and test the authentication flow. Check out
    the [router](/integration/integration#router) for the `{provider}` variable.
 
 Once the authentication is successful, the user will be redirected to the `redirect_uri` and the `request.user` will

examples/demonstration/templates/base.html

@@ -22,7 +22,7 @@
                 Simulate Login
             </a>
             {% for provider in request.auth.clients %}
-                <a href="/oauth2/{{ provider }}/auth" style="display: flex; align-items: center;">
+                <a href="/oauth2/{{ provider }}/authorize" style="display: flex; align-items: center;">
                     <img
                             alt="{{ provider }} icon"
                             src="/static/{{ provider }}.svg"

src/fastapi_oauth2/router.py

@@ -5,7 +5,7 @@
 router = APIRouter(prefix="/oauth2")
 
 
-@router.get("/{provider}/auth")
+@router.get("/{provider}/authorize")
 def authorize(request: Request, provider: str):
     if request.auth.ssr:
         return request.auth.clients[provider].authorization_redirect(request)

tests/test_router.py

@@ -5,7 +5,7 @@
 @pytest.mark.anyio
 async def test_auth_redirect(get_app):
     async with AsyncClient(app=get_app(), base_url="http://test") as client:
-        response = await client.get("/oauth2/github/auth")
+        response = await client.get("/oauth2/github/authorize")
         assert response.status_code == 303  # Redirect