@jukeplus/shop-shared

0.0.492 • Public • Published

shop-shared

前端共享文件库

使用

npm i @jukeplus/shop-shared@version -S

部署文档和包

生成文档

文档是给前后端开发看的,生成文档依赖 redoc-cli,首先安装 redoc-cli:

npm i redoc-cli -g

之后生成并且部署文档到 dev 服务器,请先测试 dev 服务器能否正常登陆,如果不行请添加 ssh 公钥或者更改部署地址。

ssh root@116.62.123.161

登录成功后运行:

npm run deploy

发布版本

npm 包,是用来生成代码以及 mock 数据的

要发包,请先确保你已经登录 npm,运行

npm login

再确认你有发包的权限,如果没有请让管理员邀请你加入 npm 的@jukeplus 组织

最后运行

npm run pub

编写文档

api-spec是项目的 API Specification,它使用 OpenAPI 来描述一个 api 的 url,请求体,请求头,返回头,返回体等。有了这个描述文件,就可以 mock 数据,生成代码,或者用来做 数据校验,测试等等。

for more detail: https://swagger.io/specification/

文档地址

Readme

Keywords

none

Package Sidebar

Install

npm i @jukeplus/shop-shared

Weekly Downloads

175

Version

0.0.492

License

MIT

Unpacked Size

452 kB

Total Files

40

Last publish

Collaborators

  • luoyp
  • 297951292
  • terranc