# ifml

**Repository Path**: blun/ifml

## Basic Information

- **Project Name**: ifml
- **Description**: 接口定义语言的解析程序
- **Primary Language**: Java
- **License**: GPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2017-05-03
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

```

#ifml 样式示例


#IFML定义：通过描述性文字来定义变量名称和值，属性名称与值，同时通过控制变量缩进的长短来定义数据的父子级关系。
#接口文档除注释部分，分为几大部分：
#接口全局定义部分；请求结构定义部分；#返回结构定义部分，三个部分。
#接口全局定义部分：有id，name，desc，url这样四个变量(顶格)，其中id和name为必输项。
#请求结构定义部分：以request为开始接点(顶格),其有head和body两个子接点，代表了请求头信息和请求body信息。
#返回结构定义部分：以response为开始接点(顶格),其有head和body两个子接点，代表了请求头信息和请求body信息。
#具体每一个参数的属性有:type,desc,mock
#其中type的值有string,number,boolean,array,object.其中当某一个节点有自定义子节点时，type默认就是object。当该节点是一个组数对象时，则可以定义为array，则为objectarray
#
#




#接口全局定义部分
id(接口的唯一标示):"1243"  #注释
name(接口的名称) :查询某用户下某具体产品信息 
desc:       结构描述结构描述结构描述结构描述结构描述结构描述结构描述结构描述结构描述结构描述结构描述结构描述结构描述结构描述结构描述结构描述结构描述结构描述结构描述结构描述
url    :/url/{1}/{2}.html



#请求结构定义部分
request(desc:"请求部分")
  #定义http头信息，url。以及cookie
  head(desc :头部信息  )
      {1}(资源归属用户代码):abc #请求结构定义
      {2}(资源代码) :ebc #请求结构定义
      #定义存放在cookie中的参数
      cookie:
        sessionid(mock:123123123123123123123123214323421)      
  #定义存放在请求body中的参数
  body(desc :请求体):
     name: "    123\13212!@@#@!#!@#!@#,[]!@#!@#!@#!@#@!####!@#@!#!@#@!#@"   #可以带空格
     password(desc :密码,type:string):"dadfd sfd\"af"



      
#返回结构定义部分
response
  head
    returncode(type:Returnid)
    returninfo
    cookie
      sessionid             
  body
    data
      pruductname
      prudctNum(type:number):100   

  Returnid:[001,002,003,004]
   
```