Interface Test measurement: interface Document specification

Interface testing is often based on not the requirements document, but the interface document.

Then, the accuracy of the interface document is very important, this article recommends two kinds of interface documents for your reference.

The interface document, regardless of its form, needs to include the following:

Interface Name

Interface type

Input parameters

The name of each parameter;

each parameter type;

Business meaning of each parameter;

Whether each is nullable;

The length of each field (optional, generally required to provide, there are strict requirements of the field to be particularly marked);

Units of each parameter (optional, Amount class field should be indicated);

D. Output results

The name of each parameter;

each parameter type;

Business meaning of each parameter;

Whether each is nullable;

Units of each parameter (optional, Amount class field should be indicated);

Returns the value range of the state and its business implication.

There are two existing forms of interface documents, each of which is given the following examples:

Document Type:

Interface Name	Account Transfer Interface
Interface type:	Accounttransferservice.transfer
Request parameters	Accounttransferrequest
Parameter classification	Parameter fields	Parameter type	Field length	Is nullable	Unit	Parameter description
Common parameters	Requestmodule	String	3	N		System unified numbering, must provide, the way the constructor
RequestTime	Date		N		Requested date
Accountrequestno	String	32	N		External System request account request number
Extension	Linkedhashmap<string, string>		Y		Extended
Accountservicecode	String	20	N		Account Service Code
RequestType	RequestType	3	N		Fixed pass APPLY
Voucher parameters	Merchantid	String	50	Y		Merchant number
Outtradeno	String	50	Y		Merchant Order Number
Tradeno	String	32	Y		Trade Serial Number
Originaltradeno	String	32	Y		Original transaction number
Tradetype	Tradetypeenum	5	Y		Type of transaction
Subtradetype	Subtradetypeenum	4	Y		Transaction subtype
Paymethod	Paymethodenum	3	Y		Payment method
Paytool	Pitypeenum	4	Y		Payment tool Type
Trademoney	Money		N	Part	Transaction amount, must fill in, if not, please keep and paymoney consistent.
Tradedate	Date		Y		Transaction date
Tradedesc	String	200	N		Trading instructions
Paymentno	String	32	Y		Payment service Flow
Payreqtime	Date		Y		Payment Initiation Time
Paytime	Date		Y		Payment Success Time
Amount	Money		N	Part	Amount paid
Cardtype	Cardtypeenum	2	Y		Card type
Channeltype	Channeltypeenum	6	Y		Channel type, manual or online
Fundchannelcode	String	32	Y		Capital Channel coding
Fundchannelname	String	32	Y		Fund Channel name
Instmerchantid	String	32	Y		Fund channel merchant number
Instorderno	String	32	Y		Capital Channel serial Number
Instinnertradeno	String	32	Y		Capital Channel internal trading serial number
Evidenceext	String	1000	N
Evidencedesc	String	128	N		Voucher Summary
interface-specific parameters	Payermemberid	String		N		Payment Party member Number
Payeraccountno	String		N		Account Number of payment party
Payeememberid	String		N		Recipient member Number
Payeeaccountno	String		N		Account number of the receiving party
Response parameters	Paymentresult
	Responsecode	String		N		Return code
	Responsedesc	String		N		Return message description
	Accountrequestno	String		N		External System request number (payment base service number)
	Evidenceno	String		N		Billing Voucher number
	Accountingday	String		N		Accounting Day of accounts

Java Doc Type:

More Wonderful content: http://www.bianceng.cnhttp://www.bianceng.cn/Programming/project/