change

68baa16f · 张允禹 · c6fe36ed · 68baa16f
Commit 68baa16f authored Aug 12, 2016 by 张允禹
Hide whitespace changes
Inline Side-by-side

Showing with 134 additions and 256 deletions

ascle.yaml ascle.yaml +134 -256

No files found.
--- a/ascle.yaml
+++ b/ascle.yaml
-# this is an example of the Uber API
-# as a demonstration of an API spec in YAML
 swagger: '2.0'
 info:
-  title: Backend
-  description: 下单
-  version: "1.0.0"
-# the domain of the service
-host: backend.test.gmei.com
-# array of all schemes that your API supports
+  title: ASCLE API
+  version: 1.0.0
+host: doctor.hotfix2.gengmei.cc
 schemes:
  - http
-# will be prefixed to all paths
-produces:
-  - application/json
+basePath: /api/web
 paths:
-  /api/settlement/create:
-    post:
-      summary: 用户下单
+  /account/user:
+    get:
+      summary: 用户信息
+      description: 用户信息
+      tags:
+        - Account
+      responses:
+        '200':
+          description: 用户信息
+        default:
+          description: Unexpected error
+  /account/captcha:
+    get:
+      summary: 图片验证码
      description: |
-        用户下单
+        展示图片验证码
+      tags:
+        - Account
+      responses:
+        '200':
+          description: 图片验证码
+        default:
+          description: Unexpected error
+  /account/login:
+    post:
+      summary: 登录
+      description: 登录
      parameters:
-        - name: use_point
+        - name: phone
          in: formData
-          description: 此单用户是否使用美分
+          description: 用户手机号.
          required: true
-          type: boolean
-        - name: coupon_id
-          in: formData
-          description: 美券id 
-          required: false
-          type: number
-        - name: service_id
+          type: string
+          format: string
+        - name: method
          in: formData
-          description: 美购id
+          description: 登录方式.
          required: true
-          type: number
-        - name: item_key
-          in: formData
-          description: 多属性key， 如果是多属性美购此项必填！
-          required: false
-          type: number
-        - name: cart_item_id
+          type: string
+          format: string
+        - name: password
          in: formData
-          description: 购物车id， id1-id2-id3 
+          description: 密码.
          required: false
          type: string
-        - name: platform
+          format: string
+        - name: authcode
          in: formData
-          description: 何种平台下单， iPhone or android or web
-          required: true
-          type: string
-        - name: phone
-          in: query
-          description: 联系人手机号发生修改才需要提交此参数
+          description: 验证码.
          required: false
          type: string
+          format: string
      tags:
-        - backend
+        - Account
      responses:
-        200:
+        '200':
          description: An array of price estimates by product
-          examples:
-            application/json:
-              error: 0
-              message: 0
-              data: 
-                status: 0
-                id: 123456
        default:
          description: Unexpected error
-          schema:
-            $ref: '#/definitions/Error'
-  /api/settlement/preview:
+  /agreement/detail:
    get:
-      summary: 下单预览
-      description: |
-        下单预览
+      summary: 协议详情
+      description: 获得单个协议的详情
      parameters:
-        - name: cart_item_id
-          in: query
-          description: 购物车商品id.
-          required: false
-          type: string
-        - name: service_id
+        - name: id
          in: query
-          description: 美购id.
+          description: 协议id
          required: true
-          type: string
-        - name: item_key
-          in: query
-          description: 多属性key.
-          required: false
-          type: string
-        - name: coupon_id
-          in: query
-          description: 美券id.
-          required: false
-          type: string
+          type: integer
+          format: integer
      tags:
-        - backend
+        - Agreement
      responses:
-        200:
+        '200':
          description: An array of price estimates by product
-          schema:
-            type: array
-            items:
-              $ref: '#/definitions/PriceEstimate'
        default:
          description: Unexpected error
-          schema:
-            $ref: '#/definitions/Error'
-  /pay/unified/refund:
+  /agreement/accept:
    post:
-      summary: 统一退款入口
-      description: 支付宝、微信、applePay、分期 根据订单pyament_channel 区分
+      summary: 接受协议
+      description: 医生点击同意协议
      parameters:
-        - name: order_id
-          in: query
-          description: 被退款的订单id.
+        - name: id
+          in: formData
+          description: 协议id
          required: true
-          type: number
+          type: integer
          format: integer
      tags:
-        - gaia
+        - Agreement
      responses:
-        200:
-          description: An array of products
-          schema:
-            type: array
-            items:
-              $ref: '#/definitions/Product'
-        default:
-          description: Unexpected error
-          schema:
-            $ref: '#/definitions/Error'
-  /pay/unified/cashback:
-    post:
-      summary: 统一返现入口
-      description: 支付宝、微信、applePay 分期不支持返现 根据订单pyament_channel 区分
-      parameters:
-        - name: order_id
-          in: query
-          description: 被退款的订单id.
-          required: true
-          type: number
+        '200':
+          description: OK
+  /agreement/no_accepted_list:
+    get:
+      summary: 没有接受的协议列表
+      description: 直接返回所有还没有接受的协议
      tags:
-        - gaia
+        - Agreement
      responses:
-        200:
-          description: Profile information for a user
-          schema:
-            $ref: '#/definitions/Profile'
-        default:
-          description: Unexpected error
-          schema:
-            $ref: '#/definitions/Error'
-  /api/coupon/info:
-    post:
-      summary: 当前登录用户所有美券信息
-      description: 当前登录用户所有美券信息
+        '200':
+          description: OK
+  agreement/accepted_list:
+    get:
+      summary: 接受的协议列表
+      description: 按照分页返回协议列表
      parameters:
-        - name: order_id
+        - name: page
          in: query
-          description: 被退款的订单id.
-          required: true
-          type: number
+          description: 请求第几页的数据，默认为1
+          required: false
+          type: integer
+          format: integer
+        - name: size
+          in: query
+          description: 请求多少条数据，默认为10
+          required: false
+          type: integer
+          format: integer
      tags:
-        - gaia
+        - Agreement
      responses:
-        200:
-          description: Profile information for a user
-          schema:
-            $ref: '#/definitions/Profile'
-        default:
-          description: Unexpected error
-          schema:
-            $ref: '#/definitions/Error'
-  /api/index/v3:
+        '200':
+          description: OK
+  /bulletin/list:
    get:
-      summary: 当前登录用户所有美券信息
-      description: 当前登录用户所有美券信息
+      summary: 公告列表
+      description: 医生公告列表
      tags:
-        - gaia
+        - bulletin
      responses:
-        200:
-          description: Profile information for a user
-          schema:
-            $ref: '#/definitions/Profile'
-        default:
-          description: Unexpected error
-          schema:
-            $ref: '#/definitions/Error'
-  /api/coupon/list:
+        '200':
+          description: OK
+          schema: {}
+          examples:
+            application/json:
+              error: 0
+              message: ''
+              data:
+                - date: 1458730446
+                  image: 'http://hera.s.gmei.com/bulletin/2016/03/23/b3e00f8825'
+                  title: 我的第一个公告
+                  content_id: 2
+              error_code: 0
+              success: true
+  /bulletin/detail:
    get:
-      summary: 当前登录用户的美券信息
-      description: 当前登录用户的美券信息
+      summary: 公告详情
+      description: 医生公告详情
+      parameters:
+        - name: id
+          in: query
+          description: 协议id
+          required: true
+          type: integer
+          format: integer
      tags:
-        - backend coupon
+        - bulletin
      responses:
-        200:
-          description: Profile information for a user
-          schema:
-            $ref: '#/definitions/Profile'
-        default:
-          description: Unexpected error
-          schema:
-            $ref: '#/definitions/Error'
-definitions:
-  Product:
-    type: object
-    properties:
-      product_id:
-        type: string
-        description: Unique identifier representing a specific product for a given latitude & longitude. For example, uberX in San Francisco will have a different product_id than uberX in Los Angeles.
-      description:
-        type: string
-        description: Description of product.
-      display_name:
-        type: string
-        description: Display name of product.
-      capacity:
-        type: string
-        description: Capacity of product. For example, 4 people.
-      image:
-        type: string
-        description: Image URL representing the product.
-  PriceEstimate:
-    type: object
-    properties:
-      product_id:
-        type: string
-        description: Unique identifier representing a specific product for a given latitude & longitude. For example, uberX in San Francisco will have a different product_id than uberX in Los Angeles
-      currency_code:
-        type: string
-        description: "[ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) currency code."
-      display_name:
-        type: string
-        description: Display name of product.
-      estimate:
-        type: string
-        description: Formatted string of estimate in local currency of the start location. Estimate could be a range, a single number (flat rate) or "Metered" for TAXI.
-      low_estimate:
-        type: number
-        description: Lower bound of the estimated price.
-      high_estimate:
-        type: number
-        description: Upper bound of the estimated price.
-      surge_multiplier:
-        type: number
-        description: Expected surge multiplier. Surge is active if surge_multiplier is greater than 1. Price estimate already factors in the surge multiplier.
-  Profile:
-    type: object
-    properties:
-      first_name:
-        type: string
-        description: First name of the Uber user.
-      last_name:
-        type: string
-        description: Last name of the Uber user.
-      email:
-        type: string
-        description: Email address of the Uber user
-      picture:
-        type: string
-        description: Image URL of the Uber user.
-      promo_code:
-        type: string
-        description: Promo code of the Uber user.
-  Activity:
-    type: object
-    properties:
-      uuid:
-        type: string
-        description: Unique identifier for the activity
-  Activities:
-    type: object
-    properties:
-      offset:
-        type: integer
-        format: int32
-        description: Position in pagination.
-      limit:
-        type: integer
-        format: int32
-        description: Number of items to retrieve (100 max).
-      count:
-        type: integer
-        format: int32
-        description: Total number of items available.
-      history:
-        type: array
-        items:
-          $ref: '#/definitions/Activity'
-  Error:
-    type: object
-    properties:
-      code:
-        type: integer
-        format: int32
-      message:
-        type: string
-      fields:
-        type: string
\ No newline at end of file
+        '200':
+          description: OK
+          schema: {}
+          examples:
+            application/json:
+              data:
+                date: 1458730446
+                image: 'http://hera.s.gmei.com/bulletin/2016/03/23/b3e00f8825'
+                title: 我的第一个公告
+                content_id: 2
+              message: ''
+              error: 0
+              success: true
+              error_code: 0
\ No newline at end of file