apiary.io简介——一个API设计网站

apiary.io是一个帮助设计API的网站。

API设计时很难得。apiary.io想帮助大家设计漂亮得API。


打开网站



点击看看它时怎么工作得,或者直接用github账号登陆,系统会提示你新建一个项目,并为你初始化了一个API文档。如下图:


左边是编写得API文档,基于markdown语法,右边时效果(点击右上角preview弹出)。

文档里包括了API的url,提交和返回的数据,对数据得解释等。

当点击保存后,点击Documentation来到,如下图。


右边的Mock Server是这个API得模拟器,可以直接访问并返回刚才文档里定义得数据,我们得API就可以测试了,哇哇。


测试得结果





还有一个追踪请求功能,相当靠谱。点击Traffic Inspector可以看到每次请求得情况和每次请求得细节。



自定义生成API文档的样式和布局通常依赖于你所使用的API文档生成工具。不同的工具如Swagger、RAML、Apiary等都提供了自己的配置方式。以下是使用Swagger进行自定义的一般步骤: 1. 配置Swagger:在你的项目中集成Swagger,通常需要引入相应的依赖库,并配置Swagger的Bean。比如,在Spring Boot项目中,你可以使用`@EnableSwagger2`注解来启用Swagger。 2. 自定义API信息:可以通过`@ApiOperation`注解来自定义每个API接口的描述、标签、响应等信息。通过`@ApiModel`和`@ApiModelProperty`注解可以定义模型的描述和属性信息。 3. 修改文档模板:Swagger允许你通过模板引擎来自定义HTML模板。例如,使用Freemarker模板来修改默认的HTML输出。 4. 调整样式:可以通过CSS来调整文档的布局和样式。你可以自定义一个样式表并通过Swagger配置将其引入。 5. 使用Swagger UI插件:Swagger UI提供了很多插件供选择,通过配置插件可以实现更加个性化的展示效果。 示例代码片段(Spring Boot中配置Swagger): ```java @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.any()) .paths(PathSelectors.any()) .build() .apiInfo(apiInfo()); } private ApiInfo apiInfo() { return new ApiInfo( "My REST API", "Some custom description of API.", "API TOS", "Terms of service", new Contact("John Doe", "www.example.com", "myeaddress@company.com"), "License of API", "API license URL", Collections.emptyList()); } } ```
评论 5
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值