Sixième, la documentation d'interface
1, le contenu Interface
nom de l'interface
description de la scène
description de l'interface
paramètre de demande
Les paramètres de réponse
Code d'erreur
2, les paramètres de la requête de contenu
Nom du champ
requis
Type de
Valeur Exemple
Description de
3, en réponse à la teneur en paramètre
Nom du champ
description
Pour revenir à l'exemple
4, le contenu du code d'erreur
Nom
Description de la
raison
Solution
5, un exemple de
6. Exercice (documentation d'interface)
L'administrateur / contrôleur / Goods.php la méthode de sauvegarde d'interface
① l'authentification de connexion contrôleur de base, commentaire.
② Copiez la sauvegarde du code de méthode à ENREG.2
Méthode ③ règles de validation des paramètres ENREG.2 de modification (suppression de la règle à jeton, en ajoutant goods_logo validation de champ)
④ Le $ this-> erreur et $ this-> partie de la réussite du code, modifié pour revenir JSON () de ce code.
⑤ méthode de téléchargement de fichiers commentaires d'invocation
⑥ par l'interface de test de facteur
⑦ écrire la documentation d'interface
7, pratique (construction du projet)
1, le déploiement de châssis de support tp (extraction de configuration d'archives site virtuel) (domaine principal, sous-domaine, et comme www.pyg.com adminapi.pyg.com)
2, division de module (module de fond d'administration, la maison de module de réception, le module interface de adminapi coulisses commun de module commun)
3, module d'administration, le module Home, le module contrôleur adminapi méthodes par défaut, vous pouvez accéder. Sous modules communs doivent uniquement modéliser le répertoire de modèle
4, la configuration de routage: domaine de routage adminapi configuration du module
5, les tentatives de modules adminapi, de créer un dispositif de commande de base, et des définitions de méthode ok méthodes échouent, les données résultantes pour le retour rapide
Par exemple:
失败时，以下两行代码 效果一样
return json(['code' => 401, 'msg' => '参数错误', 'data' => []]);
//$this->fail(401, '参数错误');
成功时，以下两行代码 效果一样
return json(['code' => 200, 'msg' => 'success', 'data' => $data]);
//$this->ok($data);
