ng-alain-sts

Convert Swagger API tosfSchema &stcolumns inng-alainprojects.

Như thế nào sử dụng

ng-alain-stsLà một cái Node cắm kiện, ngươi có thể sử dụng mệnh lệnh hành hoặc trực tiếp thuyên chuyểngeneratorPhương pháp tới thu hoạch thay đổi sausfSchema cùngstLiệt miêu tả.

#via npm
npm i ng-alain-sts --save-dev
#via yarn
yarn add -D ng-alain-sts

ng-alain

ng-alain-stsLà chuyên chú với NG-ALAIN, bởi vậy ở NG-ALAIN CLI cung cấp một cái mau lẹ mệnh lệnh:

ng g ng-alain:sts

Nó bao hàmlist,editHai cáiTự định nghĩa khuôn mẫu,Có thể thông qua mệnh lệnh căn cứ Swagger API tiếp lời kiếp sau thành danh sách, biên tập trang.

ng g ng-alain:module trade
ng g ng-alain:tpl swagger-list list -m=trade -t=trade --swaggerPath=/pet/findByStatus

Càng nhiều thỉnh tham khảostsCắm kiện.

Mệnh lệnh hành

ng-alain-sts -t=sf -p=/pet swagger.json

Tham số

Tham số danh	Loại hình	Cam chịu	Miêu tả
-t--type	sf,st	sf	Chỉ định sinh thành loại hình
-p--path	string	-	Tất điềnChỉ địnhpathsĐường nhỏ
-m--method	string	get	Chỉ định thỉnh cầu phương pháp
-c--config	string	swagger-config.json	Chỉ định phối trí văn kiện đường nhỏ

Thuyên chuyển

conststs=require('ng-alain-sts/src/generator');

awaitsts.generator(
'https://petstore.swagger.io/v2/swagger.json',
{type:'sf'},
{descriptionIsTitle:true}
);

Phối trí văn kiện

Swagger API tiếp lời đối với mỗi một cái sau đoan ngôn ngữ hoặc xí nghiệp phong cách có thống nhất mã hóa phong cách, ước định, như thế nào càng tốt lợi dụng này đó ước định sử sinh thành kết cấu càng phù hợp trước mặt khai phá phong cách, do đó tiến thêm một bước tăng lên khai phá thể nghiệm; phối trí văn kiện cho một ít càng tự do không gian, chúng ta kiến nghị nhằm vào chính mình tiếp lời phong cách định chế bất đồng phối trí tin tức.

Config

Tham số	Thuyết minh	Loại hình	Cam chịu giá trị
requestOptions	Swagger JSON văn kiệnInternet thỉnh cầu phối trí hạng	any	-
pathPrefix	Đường nhỏ tiền tố	string	-
propertyMapNames	Tự định nghĩa thuộc tính tên chiếu rọi	{ [name: string]: string }	{ id: ' đánh số ', name: ' tên ' }
descriptionIsTitle	Chỉ địnhdescriptionVìtitle,Cũng xóa bỏdescription	boolean	true
sf	sfPhối trí hạng	SFConfig	-
st	stPhối trí hạng	STConfig	-

SFConfig

Tham số	Thuyết minh	Loại hình	Cam chịu giá trị
method	Chỉ định cam chịu phương pháp danh	string	put
singleArray	Bởi vìsfCũng không duy trì loại này loại hình, cam chịu bị chuyển hóa vìselectTiểu bộ kiện	SFSchema	-
properties	Tự định nghĩa thuộc tínhSchema	PathConfig[]	-
xmlBlackNames	XML thuộc tính bạch danh sách, này đó tin tức sẽ lấy ưu tiên cấp tối cao trực tiếp truyền lại cấpui	string[]	-
propertyCallback	Đệ quy thuộc tính hồi điều	(optinos: SFPropertyCallbackOptions) => void	-
finishedCallback	Hoàn thành khi hồi điều	(optinos: SFFinishedCallbackOptions) => void	-

singleArray

Đơn loại hình số tổ cam chịu bị chuyển hóa vìselectTiểu bộ kiện:

{
type:'string',
ui:{
widget:'select',
mode:'tags',
},
default:null,
}

STConfig

Tham số	Thuyết minh	Loại hình	Cam chịu giá trị
method	Chỉ định cam chịu phương pháp danh	string	get
properties	Tự định nghĩa thuộc tínhSchema	PathConfig[]	-
nameToType	Căn cứ tên tự định nghĩa loại hình	{ [name: string]: STColumnType }	-
xmlBlackNames	XML thuộc tính bạch danh sách, này đó tin tức sẽ lấy ưu tiên cấp tối cao trực tiếp truyền lại cấpSTColumn	string[]	['i18n']
propertyCallback	Đệ quy thuộc tính hồi điều	(optinos: STPropertyCallbackOptions) => void	-
finishedCallback	Hoàn thành khi hồi điều	(optinos: STFinishedCallbackOptions) => void	-

nameToType

Định chế căn cứ tên tự định nghĩa loại hình, cam chịu giá trị vì:

{
price:'currency',
amount:'currency',
num:'number',
count:'number',
avatar:'img',
mp:'img',
modified:'date',
created:'date',
}

PathConfig

Tham số	Thuyết minh	Loại hình	Cam chịu giá trị
name	Thuộc tính tên	string	-
path	Chỉ định đường nhỏ, nếu không chỉ định tắc nên thuộc tính danh đối sở hữu path hữu hiệu	string	-
value	Giá trị chia làmSFSchemaHoặcSTColumnLoại hình	`SFSchema	STColumn`

License

MIT