Liamh

分类

未归档(172)

/ 注册

全部文章（共8篇）

全面解析 RESTful API 设计：从基础到高阶

RESTful 架构基础 REST，代表表现层状态转移（Representational State Transfer），长久以来一直是 API 服务的圣杯，最初由 Roy Fielding 在其博士论文中定义。尽管它不是构建 API 的唯一方法，但由于其广泛的普及，即使是非开发者也对其有所了解。 ...

rest restful API API 设计 API 文档接口设计后端后端开发程序员

2024-06-04

1 359

完全掌握 Swagger 中 allOf 的基本原理

Swagger 提供了一个名为 allOf 的特性，它是通过扩展已有的数据模型来构造更为复杂的数据结构的有效手段。这一特性主要用于数据模型的继承及属性的组合，有效减少了代码重复，同时增强了代码的可维护性与清晰度。访问 Swagger 官方网站可以获得更多关于S...

swagger API 接口文档后端程序员教程 API 文档

2024-05-11

0 247

入门教程：Flask 自动生成 API 文档的方法

Flasgger，作为一款强大的 Flask 扩展，自动从 Flask 应用中提取并生成 OpenAPI 规范文档，配备 SwaggerUI，为开发者提供了一条快捷通道，让 API 的文档编制和交互式测试变得简单易行。Flasgger 的设计原则是简化开发流程，通过与 Flask 框架的无缝整合，让...

Flask API API 文档后端 python 程序员接口接口文档

2024-02-04

0 461

Swagger 导入 Postman 的新手指南

在现代软件开发中，Swagger 和 Postman 作为 API 设计、开发和测试的利器，都被广泛应用。可以将 Swagger 定义的 API 导入到 Postman 中，充分利用 Postman 强大的测试特性对接口进行深入测试。以 Swagger Petstore 项目为...

postman swagger API 接口文档 API 文档教程后端前端程序员接口开发

2024-01-17

0 314

从零到一掌握 Swagger Array：完整指南和应用案例

Swagger 允许开发者定义 API 的路径、请求参数、响应和其他相关信息，以便生成可读性较高的文档和自动生成客户端代码。而 Array （数组）是一种常见的数据结构，用于存储和组织多个相同类型的数据元素。数组可以有不同的维度和大小，通过索引访问特定位置的元素。 Swagger 中对 Array ...

swagger API 文档接口文档后端开发工具接口开发 java web 开发

2023-12-08

0 585

掌握 Swagger enum：扩展功能和高级用法详解

enum 是 Swagger 规范中用来定义枚举类型的一种方式。它允许开发者在 API 文档中明确列出该接口的参数、返回值或请求体中可接受的枚举值。通过使用 Swagger enum，开发者可以更清晰地描述 API 的输入和输出，提高 API 文档的可读性和可维护性。 enum 使用场景在以下情...

swagger enum API 文档接口文档 API 程序员前端后端接口开发

2023-11-10

0 434

Swagger 自动生成 Api 文档：简化文档生成的工具

自动生成 API 文档的好处不言而喻，它可以提供给你的团队或者外部协作者，方便 API 使用者准确地调用到你的 API。为了降低手动编写文档带来的错误，很多 API 开发者会偏向于寻找一些好的方法来自动生成 API 文档。本文将会介绍一些常用的文档生成工具：开源工具 Tapir，商业化产品 Apif...

API API 文档接口文档自动生成 java 后端接口程序员 swagger

2023-07-26

0 764

横空出世！IDEA 版 API 接口神器来了，一键生成文档！

每个开发都不想写文档。当你不想写接口文档时，可以通过安装插件在 IDEA 里实现自动同步，一边写代码一边同步接口文档给你的前端、测试同学。以下内容手把手教你怎么操作（这里仅面向使用 IDEA 编辑器、遵循 Java Spring 框架注释规范的同学）：首先，你需要安装一个插件 IDEA 插件市场里...

java idea idea 插件 api 文档 java后端开发工具

2023-02-20

0 524