Using baijiafan to automatically generate API calls: progress in JS (II)

This week about automatically adding background interface documents （OpenAPI file ） Translate into JS The work of the code is developed in the first iteration , Completed based on axios A preliminary version of , meanwhile , Use the open on baijiafan API（

Zheliban SSO API

) Generated sample code , Templates and samples have been uploaded to gitee Open source repository of , details

Click to see

Generate logic description

The main generation logic is as follows ：

Entry script

index.js  Stored the entry code of the class library , The sample generation content is as follows ：

const axios = require("axios");
const config = require("./config.js");
const instance = axios.create(config);

const sso_servlet_organduser = require("./api-sso_servlet_organduser.js");
sso_servlet_organduser.injure(instance);


module.exports = instance;


The main content is to generate axios Of instance, And will instance Pass it on to everyone path Build code for , Function injection , Finally, as a unified object export, such , The user can directly require This library , To use , An example is as follows ：

const axios = require("./axios");

axios.getSsoServletOrganduser().then(res=>{
 console.log(res);
}).catch(err=>{
 console.log(err);
})


Global configuration script

config.js Store global configuration information , Including server selection and parameter settings , The sample generation content is as follows ：

module.exports = {
 //  Certification services
 baseURL: 'https://puser.zjzwfw.gov.cn/',
 
 //  Open the next line , Modify request timeout , The current example is 10s
 // timeout: 10 * 1000
}


While considering code generation , Where the interface address is generated , Use at the same time API The address description information in the document generates the description of the corresponding address , Added as a comment to the front of the address , It is convenient for users to select and modify in later development .

Interface script

For each interface defined in the interface , A corresponding interface will be automatically generated js file , With api-xxx name , Examples are as follows ：

const { verify, timestr,md5 } = require("./functions.js");

const injure = (instance)=>{
 var config = {params:{}};
 
 //  route ：sso/servlet/organduser,  Calling method GET
 
 //params The following attributes are required to be transferred , There is no sign ' Have default values ' The arguments to are passed by the caller
 //-method( Have default values )： Calling method
 //-servicecode： The access resources are SSO Business code after successful registration , from 【SSO Administrators 】 Provide .
 //-time( Have default values )： Time stamp , current time   Mm / DD / yyyy HHM / S   example ：2009 year 10 month 10 Japan  12 when 12 branch 12 The second format is 20091010121212
 //-sign( Have default values )：MD5(servicecode+servicepwd+time), Put the business code 、 Business key 、 The sending time is connected in sequence and md5 encryption . notes ：1、 Parameters servicepwd from 【SSO Administrators 】 Provide ;2、MD5 The algorithm is the standard algorithm , You can use java Internal implementation ;3、MD5 The value after is 32 Bit and lowercase .
 //-userid： The user is in SSO Unique identification of
 //-datatype( Have default values )： data format  xml json. Default xml
 //-servicepwd： Assigned password , Be careful , This parameter is only used for sign Calculation
 instance.getSsoServletOrganduser = (params = {}) => {

 var verify_err = null ||
 verify(params.servicecode,"servicecode",{"required":true}) ||
 verify(params.userid,"userid",{"required":true}) ||
 verify(params.servicepwd,"servicepwd",{"required":true});
 if ( verify_err !=null){
 return verify_err;
 }
 
 var defaultParam = { 
 datatype: "json",
 method: "getUserInfoById",
 };

 params = Object.assign(defaultParam,params);
 if (params.time == undefined){ 
 params.time= timestr("YYYYMMDDHHmmss");
 }
 if (params.sign == undefined){ 
 params.sign= md5(params.servicecode+params.servicepwd+params.time);
 }
 
 return instance.get("sso/servlet/organduser",{params});
 }
 
}

module.exports = {
 injure
}


If the interface defines get Method , Then the file will be displayed in the axios instance In the injection getXxx Methods , If it is post Then for postXxx, Other methods are analogous .

The method includes the following parts ：

• Input verification , It is defined as mandatory in the interface definition , However, the parameters that do not contain default values are used for judgment , If there is a problem with the inspection , Go straight back to reject Of Promise.

• The default value fills in , The default values are included in the interface definition , And the default value is not a parameter of the computable attribute , Build a default parameter object , Merge with the passed in parameters .

• No value passed in , But in the parameter definition , Defined as a computed property （ Is the default value in ‘=’ The properties of the beginning , for example
  timestr("YYYYMMDDHHmmss")
  ), Translate the calculation expression into the actual js Code .

• call axios The original function of , Such as get,post etc. .

Auxiliary function

The generated results also contain auxiliary functions that support the calculation properties , Currently include md5 and timestr Two functions , And the... Used for verifying parameters verify function .

const dayjs = require("dayjs");
const md5 = require("md5");

module.exports = {
 timestr: (fmt) => {
 return dayjs().format(fmt);
 },
 md5: (str) => {
 return md5(str);
 },
 verify: (par, name, option) =>{
 if (option.required && par == undefined){
 return Promise.reject(" Parameters "+name+" The request must be transmitted , But not into ");
 }
 }
}


Progress description

Based on this week's situation , Preliminary js Call generation has a rudiment , If you want to try, please pay attention to the following parts that are not implemented or tested ：

1）post The requested call generates

2） Yes openapi The defined regular expression and other input verification methods are not implemented

Welcome to try , Provide your valuable advice

API Every kind of , Completely cover all kinds of requirements , It needs a gradual improvement process , We would like your advice 、 Make complaints , And various demands , Can be in

csdn Community

Post in or on

gitee.com

Submitted in issue, Thank you very much , This part of the function will be open for trial use after the surrounding areas are improved , Coming soon .