Introduction à la spécification d'interface reposante et à l'outil de débogage Postman

J'ai récemment appris la spécification de l'interface RESTful et j'ai utilisé Postman pour la présenter. J'enregistrerai la spécification de l'interface RESTful pertinente ici :

1.

REST : il s'agit d'un style architectural pour les services Web ; il utilise des normes et des protocoles très populaires tels que HTTP, URI, XML, JSON et HTML ; il s'agit d'une conception architecturale légère, multiplateforme et multilingue ; c'est un design. Le style n'est pas une norme, mais une idée.

RESTful : le chinois correspondant est de style repos ; le service Web Restful est une application de repos courante, qui est un service Web conforme au style de repos ; le service Web de style repos est une sorte de ROA (architecture orientée ressources) ( Architecture orientée ressources) [Recommandation : front-end web] L'essence de RESTful est un style d'architecture logicielle. Le noyau est orienté ressources et résout les problèmes :

Réduire la complexité du développement

• Améliorer l'évolutivité de. le système

2. La différence entre SOAP et REST :

SOAP (Simple Object Access Protocol) : Une spécification de protocole pour l'échange de données. Il s'agit d'un protocole léger et simple basé sur XML. REST (Representational State Transfer) : Un style d'architecture logicielle qui peut réduire la complexité du développement et améliorer l'évolutivité du système.

Efficacité et facilité d'utilisation

 : SOAP
 : En raison de divers besoins qui continuent d'élargir le contenu de son propre protocole, les performances du traitement SOAP ont diminué. Dans le même temps, la facilité d’utilisation et les coûts d’apprentissage ont également augmenté. RESTful
 : En raison de sa conception d'interface orientée ressources et de son abstraction des opérations, il simplifie les mauvaises conceptions des développeurs et utilise également au maximum le concept original de conception de protocole d'application HTTP.

Sécurité

 : RESTful
est très approprié pour les interfaces de services basées sur des ressources et est particulièrement adapté aux scénarios qui nécessitent une efficacité élevée mais de faibles exigences de sécurité. La maturité de SOAP
peut apporter de la commodité à la conception de l'interface qui doit être fournie pour plusieurs langages de développement et a des exigences de sécurité plus élevées. En bref :
Sécurité
: SOAP sera meilleur que REST ; Efficacité et facilité d'utilisation
: REST est meilleur Maturité
: En général, SOAP est meilleur que REST en termes de maturité ;

3. Comment concevoir une API RESTful

 :
Chemin de la ressource : Dans l'architecture RESTful, chaque URL représente une ressource, il ne peut donc y avoir aucun verbe dans l'URL, seulement des noms. De manière générale, les noms dans les API doivent être au pluriel.

Verbe HTTP : Les opérations sur les ressources (CURD) sont représentées par des verbes HTTP (prédicats).

GET : Récupérez la ressource (un ou plusieurs éléments) depuis le serveur.

• POST : Créez une nouvelle ressource sur le serveur.
• PUT : Mise à jour des ressources sur le serveur (le client fournit l'intégralité des ressources modifiées).
• DELETE : Supprimez les ressources du serveur.
• Prenons l'exemple d'un zoo (incluant des informations sur divers animaux et employés) :

https://api.example.com/v1/zoos //动物园资源
https://api.example.com/v1/animals //动物资源
https://api.example.com/v1/employees //雇员资源

POST /zoos : Créer un nouveau zoo

• GET /zoos/ID : Obtenir des informations sur un zoo spécifié
• PUT / zoos/ID : Mettre à jour les informations d'un zoo spécifié
• DELETE /zoos/D : Supprimer un zoo

Filtrer les informations :

?limit=10 : Spécifier le nombre d'enregistrements renvoyés

• ?offset =10 : spécifiez la position de départ de l'enregistrement renvoyé.
• ?page=2&per_page=100 : Précisez quelle page et le nombre d'enregistrements par page.
• ?sortby=name&order=asc : spécifiez par quel attribut les résultats renvoyés sont triés et l'ordre de tri.
• ?animal_type_id=1 : Spécifiez les conditions de filtrage

Code de statut  :

200 (OK) - si la ressource existante a été modifiée

• 201 (créée) - si une nouvelle ressource est créée
• 202 (accepté) - La demande a été acceptée pour traitement mais n'est pas encore terminée (traitement asynchrone)
• 301 (Déplacé de façon permanente) - L'URI de la ressource a été mise à jour
• 303 (Voir Autre) - Autres (tels que charger équilibrage)
• 400 (mauvaise demande) -Fait référence à une mauvaise demande
• 404 (introuvable) -La ressource n'existe pas
• 406 (non acceptable) -Le serveur ne prend pas en charge la représentation requise
• 409 (conflit) - Conflit général
• 412 (Échec de la condition préalable) -Échec de la condition préalable (tel que des conflits lors de l'exécution des mises à jour des conditions)
• 415 (type de média non pris en charge) - La représentation reçue n'est pas prise en charge
• 500 (erreur interne du serveur) - Réponse d'erreur générique
• 503 (Service indisponible) - Le service est actuellement indisponible. Traitement des demandes

Gestion des erreurs  : Les informations renvoyées utilisent error comme nom de clé et les informations d'erreur comme valeur de clé.

{
 error: “Invalid API key”
 }

Retour des résultats :

• GET /collection：返回资源对象的列表（数组）
• GET /collection/resource：返回单个资源对象
• POST /collection：返回新生成的资源对象
• PUT /collection/resource：返回完整的资源对象
• PATCH /collection/resource：返回完整的资源对象
• DELETE /collection/resource：返回一个空文档

4.REST风格的接口测试流程：
我们直接用一张图来介绍吧
5.代码编写和Postman测试：
工具：idea，mysql数据库，Postman
数据库表数据：

实体类：

@Data
@ApiModel("用户实体类")
public class User extends Model<user> implements Serializable {
    @ApiModelProperty("用户id")
    @NotNull(message = "用户id不能为空")
    private Integer id;

    @NotBlank(message = "用户名不能为空")
    @ApiModelProperty("用户名")
    private String name;

    @Min(1)
    @Max(100)
    @ApiModelProperty("用户年龄")
    private Integer age;

    @NotEmpty(message = "邮箱不能为空")
    @ApiModelProperty("用户邮箱")
    @Email
    private String email;

    @ApiModelProperty("0:未删除 1：已删除")
    @TableLogic
    private Integer deleted;

    @NotBlank(message = "密码不能为空")
    @ApiModelProperty("用户密码")
    private String password;
    }</user>

controller层的代码（service层省略）：

@Api(tags = "用户管理")
@RestController
@RequestMapping("/MyWebsite/user")
public class UserController {
    @Autowired
    private UserServiceImpl userServiceimpl;

   @ApiOperation(value = "新增用户")
    @PostMapping
    public int insertUser(User user) {

        System.out.println("新增成功");

        return userServiceimpl.insertUser(user);
    }

    @ApiOperation(value = "修改用户信息")
    @PutMapping
    public void updateUser(@RequestBody @Valid User user) {

        userServiceimpl.updateUser(user);

        System.out.println("修改成功");
    }

    @ApiOperation(value = "删除用户", notes = "根据id删除用户")
    @DeleteMapping("/{id}")
    public int deleteUser(@ApiParam("用户id") @PathVariable @Valid Integer id) {

        System.out.println("删除成功");

        return userServiceimpl.deleteUser(id);
    }

    @ApiOperation(value = "查询所有用户")
    @GetMapping
    public List<user> allUser() {

        System.out.println("查询成功");

        return userServiceimpl.allUser();
    }

    @ApiOperation(value = "id查询用户")
    @GetMapping("/{id}")
    public User selectById(@PathVariable("id") String id) {
        return userServiceimpl.selectById(id);
    }
}</user>

利用Postman测试（url路径要对应上）：
查询所有用户：http://localhost:8081/MyWebsite/user
Header：Content-Type=application/json
Body：空

查询成功！
根据id查询：

查询成功！
新增用户：

查看数据库新增成功！

修改用户信息（修改id为7的姓名和年龄）：

查看数据库修改成功！

根据id删除用户：

查看数据库删除成功！（deleted=1）
可能你的是直接删除了整一条数据

当查询或更新或删除不存在的数据时（或者数据不合法），都是执行失败的
还有其他接口，例如删除所有等接口，这里不一一测试了
若有不正确的地方，欢迎指出。

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!