RAML
来源:互联网 发布:gs域名官网 编辑:程序博客网 时间:2024/04/28 03:21
RAML
RAML - (RESTful API Modeling Language 即RESTful API建模语言)
- 易于阅读API
- 易于设计API
- 易于共享API
- 语法简洁明了
- 关注需要定义的信息即可
- 机器可解析并生成html文档
开发工具
- API Designer
- API Console`
- API Notebook`
摘要
RAML 是一种基于HTTP-API的定义语言. 体现了所有对象传输状态的原则 . RAML基于YAML ,符合1.2版本规范,能帮助设计 RESTful API 和鼓励 API的发掘和重用 , 依靠标准和最佳实践从而编写更高质量的API . 生成全面的用户文档 .
RAML通过一个格式来提供规范的接口.作为API提供者和使用者之间的合约.用户可使用文档实现客户端和服务器的交互.
组织结构
- 基本信息 解释了如何描述核心API的方面,如它的名称、标题、位置(URI)和违约。描述如何包含API的支持文档。
- 数据类型 描述了一种通过简化模型API数据类型系统,也包括JSON和XML模式。
- 资源 描述了如何指定一个API的资源和嵌套的资源,以及在任何URI URI参数模板。
- 方法 描述了如何指定API的资源上的方法,以及他们的请求头,查询参数和请求。
- 响应 描述API规范的反应,包括状态码、媒体类型,响应头和响应。
- 资源类型和特征 描述可选机制使用RAML资源类型和特征描述资源,避免不必要的重复在一个API的定义和促进一致性和重用。
- 安全 描述了机制中可用RAML指定一个API的安全方案。
- 注释 描述了扩展机制RAML规范通过定义强类型的注释和应用规范。
- Includes,Libraries 覆盖以及扩展 描述了一个API的定义可能是由外部化定义文件,如何打包成库集合的定义,如何分离和覆盖层的元数据的RAML文档,以及一个API规范与附加功能可以扩展。
连接 : RAML官方解释
目录
用 [TOC]
来生成目录:
- RAML
- 开发工具
- 摘要
- 组织结构
- 目录
0 0
- RAML
- RAML简介
- RAML介绍
- RAML概述
- Raml些许细节
- RAML基本语法
- RAML文件的Java解析器raml-java-parser概述
- raml-for-jax-rs插件
- RAML文档生成器raml2html详解
- API设计:Swagger, Blueprint和RAML
- raml转换为html,js,markdown
- RAML的学习之路(一)
- RAML的学习之路(二)
- Spring MVC-RAML Synchronizer Sample代码分析
- 针对raml的一些使用技巧和raml-jaxrs-maven-plugin插件的使用注意
- RAML for JAX-RS的raml-to-jaxrs子项目简介
- RAML规范的Python参考实现ramlfications详解
- linux 7.2下安装构建API文档工具RAML
- 数乘
- 表单中文件上传问题
- Android中如何在ViewPager中使动态创建的ImageView铺满屏幕
- Quartz定时任务学习(1)--基本的使用方法
- SQL On Storm ——EasyCount系统概述
- RAML
- 联系人操作工具类
- 查看所有的端口占用情况
- ios 避免UIbutton快速点击造成多次响应的避免方法
- Sql中的join on语句如何在Hql中使用
- VS 编译 typedef void * POINTER_64 PVOID64错误
- Java并发编程:volatile关键字解析(三.Java内存模型)
- 《CLR via C#:框架设计》读书笔记 - 参数
- 登录界面设计PS