/
Demo

Demo

Get


Endpoint Settings


 

Name


 

这个字段会体现在XXXController中生成的API get{Name}AsyncWithXXX中.例如

Name = signin 
->getSigninAsyncWithXXX

Parameters


 

Format用Query


 

POST

Format用Body

 

{
  "Name": "SRPAPI",
  "BaseUri": "http://10.60.8.59",
  "Description": "Demo",
  "Version": "1.0",
  "AdditionalHeaders": [],
  "Authentication": {
    "Type": "CustomAuth",
    "AuthType": "CustomAuth",
    "Parameters": [
      {
        "Name": "token",
        "DefaultValue": "token"
      }
    ]
  },
  "Endpoints": [
    {
      "Name": "signin",
      "Description": "sign in",
      "HTTPMethod": "GET",
      "Group": "user",
      "RequiresAuthentication": false,
      "Route": "/sys/login/doLogin",
      "Response": {
        "Optional": false,
        "Type": "Dynamic",
        "Constant": false,
        "IsStream": false,
        "IsAttribute": false,
        "IsArray": false,
        "IsMap": false,
        "Name": "response"
      },
      "HasOptionalQueryParams": false,
      "HasOptionalFieldParams": false,
      "CollectParameters": false,
      "Parameters": [
        {
          "ParamFormat": "Query",
          "Optional": false,
          "Type": "String",
          "Constant": false,
          "IsStream": false,
          "IsAttribute": false,
          "IsArray": false,
          "IsMap": false,
          "Name": "staffId",
          "DefaultValue": "S0002"
        },
        {
          "ParamFormat": "Query",
          "Optional": false,
          "Type": "String",
          "Constant": false,
          "IsStream": false,
          "IsAttribute": false,
          "IsArray": false,
          "IsMap": false,
          "Name": "password"
        }
      ],
      "Errors": []
    },
    {
      "Name": "message",
      "Description": "message",
      "HTTPMethod": "POST",
      "Group": "message",
      "RequiresAuthentication": true,
      "Route": "/sys/msg/list",
      "Response": {
        "Optional": false,
        "Type": "SRPMessageList",
        "Constant": false,
        "IsStream": false,
        "IsAttribute": false,
        "IsArray": false,
        "IsMap": false,
        "Name": "response"
      },
      "HasOptionalQueryParams": false,
      "HasOptionalFieldParams": false,
      "CollectParameters": false,
      "Parameters": [
        {
          "ParamFormat": "Body",
          "Optional": false,
          "Type": "SRPMessageRequest",
          "Constant": false,
          "IsStream": false,
          "IsAttribute": false,
          "IsArray": false,
          "IsMap": false,
          "Name": "messageRequest"
        }
      ],
      "Errors": []
    }
  ],
  "CustomTypes": [
    {
      "Name": "SRPUser",
      "ImplementationType": "Structure",
      "Description": "user",
      "Fields": [
        {
          "Optional": false,
          "Type": "String",
          "Constant": false,
          "IsStream": false,
          "IsAttribute": false,
          "IsArray": false,
          "IsMap": false,
          "Name": "staffId"
        },
        {
          "Optional": false,
          "Type": "String",
          "Constant": false,
          "IsStream": false,
          "IsAttribute": false,
          "IsArray": false,
          "IsMap": false,
          "Name": "password"
        },
        {
          "Optional": false,
          "Type": "String",
          "Constant": false,
          "IsStream": false,
          "IsAttribute": false,
          "IsArray": false,
          "IsMap": false,
          "Name": "token"
        }
      ]
    },
    {
      "Name": "SRPMessageRequest",
      "ImplementationType": "Structure",
      "Description": "SRPMessageRequest",
      "Fields": [
        {
          "Optional": false,
          "Type": "String",
          "Constant": false,
          "IsStream": false,
          "IsAttribute": false,
          "IsArray": false,
          "IsMap": false,
          "Name": "iDisplayLength"
        },
        {
          "Optional": false,
          "Type": "String",
          "Constant": false,
          "IsStream": false,
          "IsAttribute": false,
          "IsArray": false,
          "IsMap": false,
          "Name": "iDisplayStart"
        },
        {
          "Optional": false,
          "Type": "String",
          "Constant": false,
          "IsStream": false,
          "IsAttribute": false,
          "IsArray": false,
          "IsMap": false,
          "Name": "startTime"
        },
        {
          "Optional": false,
          "Type": "String",
          "Constant": false,
          "IsStream": false,
          "IsAttribute": false,
          "IsArray": false,
          "IsMap": false,
          "Name": "endTime"
        },
        {
          "Optional": false,
          "Type": "String",
          "Constant": false,
          "IsStream": false,
          "IsAttribute": false,
          "IsArray": false,
          "IsMap": false,
          "Name": "token"
        }
      ]
    },
    {
      "Name": "SRPMessageList",
      "ImplementationType": "Structure",
      "Description": "SRPMessageList",
      "Fields": [
        {
          "Optional": false,
          "Type": "Precision",
          "Constant": false,
          "IsStream": false,
          "IsAttribute": false,
          "IsArray": true,
          "IsMap": false,
          "Name": "data"
        }
      ]
    }
  ],
  "CodeGenSettings": {
    "SynchronyMode": 0,
    "ModelSerializationScheme": "Json",
    "ArraySerialization": "Indexed",
    "UseHttpMethodPrefix": true,
    "UseModelPrefix": false,
    "UseEnumPrefix": true,
    "UseControllerPrefix": true,
    "UseConstructorsForConfig": true,
    "AndroidUseAppManifest": true,
    "iOSUseAppInfoPlist": true,
    "iOSGenerateCoreData": false,
    "CollapseParamsToArray": false,
    "RunscopeEnabled": false,
    "AndroidHttpClient": "UNIREST",
    "ObjCHttpClient": "UNIREST",
    "CSharpHttpClient": "UNIREST",
    "PHPHttpClient": "UNIREST",
    "EnableAdditionalModelProperties": false,
    "PreserveParameterOrder": false,
    "AppendContentHeaders": true,
    "GenerateInterfaces": false,
    "UseCommonSDKLibrary": false,
    "BodySerialization": 0
  },
  "Errors": []
}