Skip to content

Latest commit

 

History

History
566 lines (427 loc) · 10.7 KB

API Document.md

File metadata and controls

566 lines (427 loc) · 10.7 KB

API Document

Deployment

Docker

MySQL

NAMES PORTS
orders 3313
management 3312
bank 3311
components 3310
oem 3309
factory 3308
warehouse 3307
finance 3306
delivery 3305
oem-adapter-db 3300

Back-End

NAMES PORTS
intergration 8079
oem(JSON) 8081
oem(XML) 8082
factory(JSON) 8083
factory(XML) 8084
bank 8085
components 8086
oem-adapter 8000
delivery(express) 8001

Warehouse

Use Scenario

  • Put the raw material in the warehouse.

  • The factory fetch raw material from the warehouse.

  • The factory or foundry put the product in the warehouse.

  • The background management system check the inventory in warehouse.

  • The background management system fetch product from the warehouse.

ER Design

  • product_transfer

    Domain Type
    id INT
    number INT
    time Datetime
    product_id INT
    type VARCHAR(20)
    state INT

  • product

    Domain Type
    id INT
    name VARCHAR(20)
    price INT
    remain INT

  • material

    Domain Type
    id INT
    name VARCHAR(20)
    number INT

  • material_transfer

    Domain Type
    id INT
    remain INT
    time Datetime
    material_id INT
    type INT
    state INT

API

  • Product Information

    • Check Product list

      • URL GET /warehouse/products

      • Authority SUPER PRODUCT_MANAGEMENT

      • Response

        {
    "code": 200,
    "message": "success",
    "content": [
        {
            "id": 1,
            "name": "iphone X",
            "description": "Our vision has always been to create an iPhone that is entirely screen. One so immersive the device itself disappears into the experience. And so intelligent it can respond to a tap, your voice, and even a glance. With iPhone X, that vision is now a reality. Say hello to the future.",
            "price": 8388,
            "num": 270
        }
    ]
}

    • Create new product entry

      • URL POST /warehouse/product

      • Authority SUPER CREATE_PRODUCT

      • Body

        {
  "name": "Mac Pro", 
  "description": "Mac has always been built around a singular vision: to create machines that are as powerful and functional as they are beautiful and intuitive. Mac Pro is a stunning realization of that ideal. All the elements that define a pro computer — graphics, storage, expansion, processing power, and memory — have been rethought and reengineered. So you have the power and performance to bring your biggest ideas to life.", 
  "price": 21888
}

    • Modify product info

      • URL PUT /warehouse/product/{product_id}

      • Body

        {
  "name": "Mac Pro", 
  "description": "Mac has always been built around a singular vision: to create machines that are as powerful and functional as they are beautiful and intuitive. Mac Pro is a stunning realization of that ideal. All the elements that define a pro computer — graphics, storage, expansion, processing power, and memory — have been rethought and reengineered. So you have the power and performance to bring your biggest ideas to life.", 
  "price": 20888
}

  • Product Transfer

    • View transfer history

      • URL GET /warehouse/product/transfers?start=date&end=date&state=()

      • Body

        {
    "code": 200,
    "message": "success",
    "content": [
        {
            "id": 2,
            "num": 10,
            "name": "iphone X",
            "p_id": 1,
            "type": 0,
            "state": 1,
            "time": 1515520763000
        },
        {
            "id": 3,
            "num": 10,
            "name": "iphone X",
            "p_id": 1,
            "type": 0,
            "state": 1,
            "time": 1515521834000
        },
        {
            "id": 4,
            "num": 100,
            "name": "iMac pro",
            "p_id": 2,
            "type": 0,
            "state": 1,
            "time": 1515524462000
        },
        {
            "id": 5,
            "num": 100,
            "name": "iMac pro",
            "p_id": 2,
            "type": 0,
            "state": 1,
            "time": 1515524465000
        }
    ]
}

    • Put/Fetch product request

      • URL POST /warehouse/product/put(or fetch)

      • Authority SUPER PUT_PRODUCT FETCH_PRODUCT

      • Body

        {
    "p_id": 2,
    "num": 2,
}

    • Accept Transfer

      • URL PUT /warehouse/product/transefer/{transfer_id}?state=?

      • Body

        

        • 

      

      • 

    

    • 

  • 

    Material
    

      

    • URL  POST /material
      • 

    • The same as product
      • 

    

    • 



Factory


Use Scenario


    

  • The backstage management system place order to factory
    • 

  • Confirm order
    • 

  • The backstage management system check task information
    • 



ER Design






Domain
type
commit






Id
INT





product_id
INT





number
INT





state
INT





time
Datetime







API


    

  • 

    Place Order
    

      

    • 

      URL: POST /factory/order
      

      • 

    • 

      Body
      

      {
  "id": 1,
  "num": 1
}
      

      • 

    

    • 

  • 

    Update order
    

      

    • 

      URL: PUT /factory/order
      

      • 

    • 

      Body
      

      {
  "id": 1,
  "p_id": 1,
  "num": 500,
  "state": 1,
  "time": 1515497018000
}
      

      • 

    

    • 

  • 

    View order
    

      

    • 

      URL: GET /facotry/orders
      

      • 

    • 

      Body
      

      {
    "code": 200,
    "message": "success",
    "content": [
        {
            "id": 1,
            "state": 0,
            "p_id": 1,
            "num": 50,
            "time": 1515497015000
        },
        {
            "id": 2,
            "state": 0,
            "p_id": 1,
            "num": 50,
            "time": 1515497018000
        }
    ]
}
      

      • 

    

    • 



OEM Adapter


API


    

  • 

    post order
    

    POST http://10.0.1.2:8000/oem/order

User => Management
RequestBody {materialId, materialName, materialNo, oem}
Response {code} "0" is ok, "1" is error

    

    • 

  • 

    get order
    

    GET http://10.0.1.2:8000/oem/order

User => Management
Response {[orderId, materialId, materialName, materialNo, amount, time, oem]}

    

    • 



ER Design






Domain
Type






order_id
INT




material_id
INT




material_name
VARCHAR(20)




material_no
INT




amount
INT




time
Datetime




oem
VARCHAR(20)






Components Adapter


API


    

  • 

    post order
    

    POST http://10.0.1.2:8086/components/order

User => Management
RequestBody {componentsId, componentsName, componentsNo}
Response {code} "0" is ok, "1" is error

    

    • 



ER Design






Domain
Type






order_id
INT




component_id
INT




component_no
INT




amount
INT




time
Datetime






Bank Adapter


API


    

  • 

    transfer
    

    POST http://10.0.1.2:8085/bank/transfer 

User => FinanceSystem
RequestBody {fromAcount, toAccount, sum}
Response {code} "0" is ok, "1" is error

    

    • 

  • 

    view balance
    

    User => User
GET http://10.0.1.2:8085/bank/balance/{account}
Response {num} num is balance

    

    • 



Finance Service


API


    

  • 

    transfer
    

    URL:
    

    http://10.0.1.2:3223/finance/transfer

    

    POST:
    

    User => Management
RequestBody {"fromAccount":"1552730","toAccount":"1552732", "sum":110000}

    

    Response:
    

    {
    "code": 200,
    "message": "success",
    "content": "0"
}

    

    • 

  • 

    view bill
    

    • 



ER Design






Domain
Type






id
INT




type
VARCHAR(20)




relation_id
INT




amount
INT




time
Datetime






URL


http://10.0.1.2:3224/finance/bill?start=2017-12-30



HTTP Mode


User => Management
RequestBody {fromDate, toDate}
Response {bills} the list of bill from one stage to another stage



Response


{
    "code": 200,
    "message": "success",
    "content": [
        {
            "fromAccount": "1552700",
            "toAccount": "1552701",
            "sum": 100000
        },
        {
            "fromAccount": "1552730",
            "toAccount": "1552732",
            "sum": 110000
        }
    ]
}



Express Adapter


API


    

  • 

    post order
    

    URL
    

    http://10.0.1.2:8001/express/deliver

    

    HTTP Mode
    

    POST

    

    RequstBody
    

    {
    fromUser:
    toUser:
    source: 
    destination: 
    fromUserPhone: 
    toUserPhone:
}

    

    Response
    

    {
    "code": 200,
    "message": "success",
    "content": 
}

    

    • 

  • 

    view express
    

    URL
    

    http://10.0.1.2:8001/express/deliveries

    

    HTTP Mode
    

    GET

    

    Response
    

    {
    "code": 200,
    "message": "success",
    "content": [
        {
            "id": 0,
            "fromUser": "Phoenix",
            "fromUserPhone": "18000000001",
            "toUser": "Hadoop",
            "toUserPhone": "18000000001",
            "source": "Tongji University",
            "destination": "Tongji University, Caoan HighWay",
            "time": 1515569827000,
            "state": 0
        },
        {
            "id": 0,
            "fromUser": "Phoenix",
            "fromUserPhone": "18000000001",
            "toUser": "Hadoop",
            "toUserPhone": "18000000001",
            "source": "Tongji University",
            "destination": "Tongji University, Caoan HighWay",
            "time": 1515569796000,
            "state": 0
        }
    ]
}

    

    • 



ER Design






Domain
Type






id
INT




order_id
INT




state
INT




create_time
Datetime