1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
|
# config\packages\nelmio_api_doc.yaml
nelmio_api_doc:
documentation:
info:
title: Books
description: Une API d'Open Classrooms avec des livres, des autrices et des auteurs !
version: 2.0.0
paths:
/api/login_check:
post:
operationId: postCredentialsItem
tags:
- Token
summary: Permet d'obtenir le token JWT pour se logger.
requestBody:
description: Crée un nouveau token JWT
content:
application/json:
schema:
$ref: '#/components/schemas/Credentials'
responses:
'200':
description: Récupère le token JWT
content:
application/json:
schema:
$ref: '#/components/schemas/Token'
components:
schemas:
Token:
type: object
properties:
token:
type: string
readOnly: true
Credentials:
type: object
properties:
username:
type: string
default: admin@bookapi.com
password:
type: string
default: password
securitySchemes:
bearerAuth:
type: apiKey
in: header
name: Authorization # or another header name
security:
- bearerAuth: []
areas: # to filter documented areas
path_patterns:
- ^/api(?!/doc$) # Accepts routes under /api except /api/doc |
Partager