<commit_before># API Doc

Comme Easy.js se veut être un framework uniquement dédié pour du traitement backend, donc pas de génération de vues, apidoc a été implémenté dans le workflow du framework afin de pouvoir générer un site statique permettant de tester votre API.

Pour plus d'informations sur le fonctionnement de apidoc, vous pouvez vous referrer à sa [documentation](apidocjs.com).

Vos fichiers de documentation d'API doivent se situer dans le dossier `doc/` de vos bundles, c'est ici que apidoc ira chercher vos fichier de description. Il a été convenu ainsi afin d'éviter de trop lourdes annotations dans vos contrôleurs.

Example :

```javascript
/** 
 * getRoles - get all roles 
 * 
 * @api {get} /roles Get all roles 
 * @apiName GetRoles 
 * @apiGroup Role 
 * 
 * 
 * @apiSuccess {Array[Role]} raw Return table of roles 
 * @apiSuccessExample {json} Success-Response: 
 * HTTP/1.1 200 OK 
 * [ 
 *   { 
 *     "id": 1, 
 *     "name": "Administrator", 
 *     "slug": "administrator" 
 *   } 
 * ] 
 * 
 * @apiUse InternalServerError 
 */
```

Parler du fichier config de apidoc : src/config/apidoc.js
<commit_msg>Updates apidoc.md<commit_after># API Doc

Comme Easy.js se veut être un framework uniquement dédié pour du traitement backend, donc pas de génération de vues, apidoc a été implémenté dans le workflow du framework afin de pouvoir générer un site statique permettant de tester votre API.

Pour plus d'informations sur le fonctionnement de apidoc, vous pouvez vous referrer à sa [documentation](apidocjs.com).

Vos fichiers de documentation d'API doivent se situer dans le dossier `doc/` de vos bundles, c'est ici que apidoc ira chercher vos fichier de description. Il a été convenu ainsi afin d'éviter de trop lourdes annotations dans vos contrôleurs.

Example :

```javascript
/** 
 * getRoles - get all roles 
 * 
 * @api {get} /roles Get all roles 
 * @apiName GetRoles 
 * @apiGroup Role 
 * 
 * 
 * @apiSuccess {Array[Role]} raw Return table of roles 
 * @apiSuccessExample {json} Success-Response: 
 * HTTP/1.1 200 OK 
 * [ 
 *   { 
 *     "id": 1, 
 *     "name": "Administrator", 
 *     "slug": "administrator" 
 *   } 
 * ] 
 * 
 * @apiUse InternalServerError 
 */
```

Vous disposez d'un fichier de configuration, `~/src/config/apidoc.js`, permettant de définir des scénarios préconstruits, utilisable dans les documentations api des bundles.

{'fraction_non_alphanumeric': 0.08682885906040269, 'fraction_numerical': 0.0050335570469798654, 'mean_word_length': 3.6310679611650487, 'pattern_counts': {'":': 6, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4166679', 'n_tokens_mistral': 824, 'n_tokens_neox': 745, 'n_words': 296}