Coverage for tests/test_security_api_key_header_description.py: 100%

1from fastapi import Depends, FastAPI, Security 5 ctx1abcde

2from fastapi.security import APIKeyHeader 5 ctx1abcde

3from fastapi.testclient import TestClient 5 ctx1abcde

4from pydantic import BaseModel 5 ctx1abcde

5 

6app = FastAPI() 5 ctx1abcde

7 

8api_key = APIKeyHeader(name="key", description="An API Key Header") 5 ctx1abcde

9 

10 

11class User(BaseModel): 5 ctx1abcde

12 username: str 5 ctx1abcde

13 

14 

15def get_current_user(oauth_header: str = Security(api_key)): 5 ctx1abcde

16 user = User(username=oauth_header) 5 ctx1abcde

17 return user 5 ctx1abcde

18 

19 

20@app.get("/users/me") 5 ctx1abcde

21def read_current_user(current_user: User = Depends(get_current_user)): 5 ctx1abcde

22 return current_user 5 ctx1abcde

23 

24 

25client = TestClient(app) 5 ctx1abcde

26 

27 

28def test_security_api_key(): 5 ctx1abcde

29 response = client.get("/users/me", headers={"key": "secret"}) 5 ctx1abcde

30 assert response.status_code == 200, response.text 5 ctx1abcde

31 assert response.json() == {"username": "secret"} 5 ctx1abcde

32 

33 

34def test_security_api_key_no_key(): 5 ctx1abcde

35 response = client.get("/users/me") 5 ctx1abcde

36 assert response.status_code == 403, response.text 5 ctx1abcde

37 assert response.json() == {"detail": "Not authenticated"} 5 ctx1abcde

38 

39 

40def test_openapi_schema(): 5 ctx1abcde

41 response = client.get("/openapi.json") 5 ctx1abcde

42 assert response.status_code == 200, response.text 5 ctx1abcde

43 assert response.json() == { 5 ctx1abcde

44 "openapi": "3.1.0", 

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

46 "paths": { 

47 "/users/me": { 

48 "get": { 

49 "responses": { 

50 "200": { 

51 "description": "Successful Response", 

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

53 } 

54 }, 

55 "summary": "Read Current User", 

56 "operationId": "read_current_user_users_me_get", 

57 "security": [{"APIKeyHeader": []}], 

58 } 

59 } 

60 }, 

61 "components": { 

62 "securitySchemes": { 

63 "APIKeyHeader": { 

64 "type": "apiKey", 

65 "name": "key", 

66 "in": "header", 

67 "description": "An API Key Header", 

68 } 

69 } 

70 }, 

71 }