Scenario: When the company’s outbound call interface connects with Dongfeng Nissan, two interfaces, task list interface and task data push interface, are needed

Document format: Mainly divided into three parts

  • With the title of the document, you can see what the document is about at a glance
  • Document change records, including the date, version, change, changed content, and changed person, are attached with the change description, as shown in the following example

  • Document interface, also the main content; It mainly includes the following contents

  • The name of the interface

  • Request type — uppercase

  • Request parameters

  • The parameter name

  • Type (distinguish objects from arrays of objects)

  • note

  • Sample code for request parameters

  • Response parameters

  • The parameter name

  • type

  • note

  • Sample code for response parameters