Coverage for tests/test_security_api_key_query_description.py: 100%

1from fastapi import Depends, FastAPI, Security 7 ctx1abcdefg

2from fastapi.security import APIKeyQuery 7 ctx1abcdefg

3from fastapi.testclient import TestClient 7 ctx1abcdefg

4from pydantic import BaseModel 7 ctx1abcdefg

5 

6app = FastAPI() 7 ctx1abcdefg

7 

8api_key = APIKeyQuery(name="key", description="API Key Query") 7 ctx1abcdefg

9 

10 

11class User(BaseModel): 7 ctx1abcdefg

12 username: str 7 ctx1abcdefg

13 

14 

15def get_current_user(oauth_header: str = Security(api_key)): 7 ctx1abcdefg

16 user = User(username=oauth_header) 7 ctx1hijklmn

17 return user 7 ctx1hijklmn

18 

19 

20@app.get("/users/me") 7 ctx1abcdefg

21def read_current_user(current_user: User = Depends(get_current_user)): 7 ctx1abcdefg

22 return current_user 7 ctx1hijklmn

23 

24 

25client = TestClient(app) 7 ctx1abcdefg

26 

27 

28def test_security_api_key(): 7 ctx1abcdefg

29 response = client.get("/users/me?key=secret") 7 ctx1hijklmn

30 assert response.status_code == 200, response.text 7 ctx1hijklmn

31 assert response.json() == {"username": "secret"} 7 ctx1hijklmn

32 

33 

34def test_security_api_key_no_key(): 7 ctx1abcdefg

35 response = client.get("/users/me") 7 ctx1opqrstu

36 assert response.status_code == 401, response.text 7 ctx1opqrstu

37 assert response.json() == {"detail": "Not authenticated"} 7 ctx1opqrstu

38 assert response.headers["WWW-Authenticate"] == "APIKey" 7 ctx1opqrstu

39 

40 

41def test_openapi_schema(): 7 ctx1abcdefg

42 response = client.get("/openapi.json") 7 ctx1vwxyzAB

43 assert response.status_code == 200, response.text 7 ctx1vwxyzAB

44 assert response.json() == { 7 ctx1vwxyzAB

45 "openapi": "3.1.0", 

46 "info": {"title": "FastAPI", "version": "0.1.0"}, 

47 "paths": { 

48 "/users/me": { 

49 "get": { 

50 "responses": { 

51 "200": { 

52 "description": "Successful Response", 

53 "content": {"application/json": {"schema": {}}}, 

54 } 

55 }, 

56 "summary": "Read Current User", 

57 "operationId": "read_current_user_users_me_get", 

58 "security": [{"APIKeyQuery": []}], 

59 } 

60 } 

61 }, 

62 "components": { 

63 "securitySchemes": { 

64 "APIKeyQuery": { 

65 "type": "apiKey", 

66 "name": "key", 

67 "in": "query", 

68 "description": "API Key Query", 

69 } 

70 } 

71 }, 

72 }