国产 无码 综合区,色欲AV无码国产永久播放,无码天堂亚洲国产AV,国产日韩欧美女同一区二区

讀取swagger接口文檔、自動生成前端ts或js代碼

這篇具有很好參考價值的文章主要介紹了讀取swagger接口文檔、自動生成前端ts或js代碼。希望對大家有所幫助。如果存在錯誤或未考慮完全的地方,請大家不吝賜教,您也可以點擊"舉報違法"按鈕提交疑問。

依據(jù) swagger(openapi) 文檔一鍵生成 typescript 或 javascript 代碼

平時在和后端對接時,總是要把后端swagger聲明好的類型在ts中再實現(xiàn)一遍,寫一堆interface;今天推薦一個庫,可以根據(jù)swagger文檔,直接生成ts 或 js代碼,并且有良好的代碼提示

注意:swagger文檔版本需要3.0及以上

先上效果圖

swagger 生成js,前端,javascript,開發(fā)語言,typescript,json
swagger 生成js,前端,javascript,開發(fā)語言,typescript,json

swagger 生成js,前端,javascript,開發(fā)語言,typescript,json

1.安裝腳手架


npm i -g @zeronejs/cli

2.打開你的項目

我這里快速創(chuàng)建下


npm ini -y

然后創(chuàng)建一個swagger.config.json文件

配置示例:


{
   "docsUrl": "http://www.example.com/v3/api-docs",
   "axiosInstanceUrl": "axios"
}

swagger 生成js,前端,javascript,開發(fā)語言,typescript,json

其中docsUrl指的是swagger頁面上json鏈接地址

swagger 生成js,前端,javascript,開發(fā)語言,typescript,json

swagger 生成js,前端,javascript,開發(fā)語言,typescript,json

當(dāng)然你也可以指定本地json文件

swagger 生成js,前端,javascript,開發(fā)語言,typescript,json

3.運行命令

3.1 ts代碼

zerone api

3.2 js代碼

生成js依賴于axios,請先安裝axios


npm install axios

zerone api -js

swagger 生成js,前端,javascript,開發(fā)語言,typescript,json

代碼已生成!執(zhí)行成功??!

4. 實戰(zhàn)操作

通常我們的項目并不在根目錄,稍微修改下…

我們把swagger.config.jsondocs.json 放在 /src/api 下,如果需要創(chuàng)建axios實例的話,axiosInstanceUrl換成實例的地址

swagger 生成js,前端,javascript,開發(fā)語言,typescript,json

4.1運行命令

ts代碼

zerone api -p ./src/api

js代碼

zerone api -js -p ./src/api

swagger 生成js,前端,javascript,開發(fā)語言,typescript,json

生成成功!

由于也自動生成了相應(yīng)的declare文件,所以就算是js也會有很好的代碼提示

swagger 生成js,前端,javascript,開發(fā)語言,typescript,json

完整demo代碼:https://gitee.com/zzh948498/swagger-to-ts

官方文檔地址:zeronejs (ps: 文檔目前掛載在github上)

源碼地址:https://github.com/zeronejs/zerone文章來源地址http://www.zghlxwxcb.cn/news/detail-635967.html

到了這里,關(guān)于讀取swagger接口文檔、自動生成前端ts或js代碼的文章就介紹完了。如果您還想了解更多內(nèi)容,請在右上角搜索TOY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章,希望大家以后多多支持TOY模板網(wǎng)!

本文來自互聯(lián)網(wǎng)用戶投稿,該文觀點僅代表作者本人,不代表本站立場。本站僅提供信息存儲空間服務(wù),不擁有所有權(quán),不承擔(dān)相關(guān)法律責(zé)任。如若轉(zhuǎn)載,請注明出處: 如若內(nèi)容造成侵權(quán)/違法違規(guī)/事實不符,請點擊違法舉報進行投訴反饋,一經(jīng)查實,立即刪除!

領(lǐng)支付寶紅包贊助服務(wù)器費用

相關(guān)文章

  • postman自動生成接口文檔

    postman自動生成接口文檔

    ?點擊: ?會自動生成一個文件夾 ? ?點擊圖表,修改名字 新建一個請求,到時候會自動保存到文件夾里面,但是保存前看清楚保存的名字 ? ?點擊三個點-》點擊export即可

    2024年02月11日
    瀏覽(24)
  • Python自動化測試——在線生成接口文檔

    Python自動化測試——在線生成接口文檔

    目錄 前言 API 文檔導(dǎo)入生成 在項目詳情頁點擊左側(cè) API 功能,進入 API 管理頁面,直接點擊下拉框選擇導(dǎo)入 API? 自動生成文檔 通過使用接口文檔工具 Eolink 演示如何自動生成文檔 使用 API Factory 產(chǎn)品根據(jù)數(shù)據(jù)庫生成 API 文檔 結(jié)語 接口文檔是項目開發(fā)中必需的說明文檔,接口文

    2024年02月07日
    瀏覽(21)
  • 【Apifox Helper】自動生成接口文檔,IDEA+Apifox懶人必備

    【Apifox Helper】自動生成接口文檔,IDEA+Apifox懶人必備

    ??緣由 接口文檔對接爽,整理起來真費腦 對于 整理API文檔 ,本狗秉承偷懶為上的原則,想找一種 在IDEA中直接生成文檔 的方法。 Apifox Helper 絕絕子,只需要在 IDEA中下載插件 ,無腦配置后, 文檔自動生成到Apifox ,美完美解決。并且 顏值及方便程度 絕比Swagger和postman好太

    2024年02月02日
    瀏覽(21)
  • 自動生成數(shù)據(jù)庫設(shè)計文檔,支持多數(shù)據(jù)源批量生成(Word文檔)

    自動生成數(shù)據(jù)庫設(shè)計文檔,支持多數(shù)據(jù)源批量生成(Word文檔)

    ? ? ? 在做項目時通常使用PowerDesigner設(shè)計數(shù)據(jù)庫,但在項目完成交付項目給客戶的時候常常需要一份Word版本的數(shù)據(jù)庫文檔給客戶,你不能指望每個客戶都會用PowerDesigner,所以基于當(dāng)前開發(fā)數(shù)據(jù)庫生成數(shù)據(jù)庫文檔就是最佳選擇,如果手動編寫數(shù)據(jù)庫文檔那將是一件非常痛苦的

    2024年04月23日
    瀏覽(30)
  • gin中使用swagger生成接口文檔

    gin中使用swagger生成接口文檔

    想要使用 gin-swagger 為你的代碼自動生成接口文檔,一般需要下面三個步驟: 按照swagger要求給接口代碼添加聲明式注釋,具體參照聲明式注釋格式。 使用swag工具掃描代碼自動生成API接口文檔數(shù)據(jù) 使用gin-swagger渲染在線接口文檔頁面 第一步:添加注釋 在程序入口main函數(shù)上以

    2024年01月25日
    瀏覽(17)
  • Apikit 自學(xué)日記:自動生成 API 文檔

    Apikit 自學(xué)日記:自動生成 API 文檔

    功能入口 :API管理應(yīng)用 / 選中某個項目 / 其他菜單 / 數(shù)據(jù)源同步(API文檔自動生成) 該功能可通過配置數(shù)據(jù)源信息,實現(xiàn)基于數(shù)據(jù)源的API信息自動生成API文檔。 當(dāng)前支持5種數(shù)據(jù)源: Swagger URL、apiDoc、Github、gitlab、碼云 。 Swagger URL和apiDoc的數(shù)據(jù)源配置方式一致,僅需填寫來

    2024年02月11日
    瀏覽(28)
  • Mongodb 集合插入文檔自動生成ObjectId

    Mongodb 使用以下幾種方法來插入文檔 , Mongodb V5.0+ 使用 mongosh 客戶端: 插入單個文檔 db.collection.insertOne() 將單個 文檔插入到集合中。 如果該集合當(dāng)前不存在,則插入操作將創(chuàng)建該集合。 如果文檔未指定_id字段,則將在插入之前 mongod 添加該字段并為文檔_id分配唯一的字段

    2024年02月12日
    瀏覽(21)
  • word文檔批量生成工具(附免費軟件)(按Excel表格內(nèi)容自動替換內(nèi)容生成文檔)

    word文檔批量生成工具(附免費軟件)(按Excel表格內(nèi)容自動替換內(nèi)容生成文檔)

    批量生成word文檔是讓人無比厭惡但有時又不得不做的事情。比如學(xué)校要給擬錄取的學(xué)生發(fā)通知書,就可能需要批量生成一批只有“姓名”、“學(xué)院”和“專業(yè)”不同,其他內(nèi)容都相同的word文檔以供打?。ㄊ聦嵣现苯由蓀df是更好的選擇,這個以后有心情可以弄一下)。 要實

    2024年02月11日
    瀏覽(29)
  • SpringBoot使用Swagger2生成接口文檔

    SpringBoot使用Swagger2生成接口文檔

    ? ? ? ? 通過一下配置,將Swagger2自動配置進SpringBoot中 ? ????????? 通過@Api注解和@ApiOperation注解說明模塊作用及接口說明。 ? ? ? ? 通過訪問路徑http://localhost:8088/doc.html,說明一下8088是我SpringBoot的端口號,你們填你們自己的,不同版本的Swagger訪問的路徑是不一樣的。

    2024年01月25日
    瀏覽(32)
  • 【easytestapi,文檔即測試,自動生成測試用例】

    個人編寫的一個開源測試工具,GitHub - easytestapi/easytestapi: 生產(chǎn)力?。?! 目前主要用戶接口功能自動化測試,其核心思想是文檔即測試。 文檔是接口文檔。通過我定義的標(biāo)準(zhǔn)化的接口文檔,可生成測試用例,也可直接執(zhí)行測試。 目前沒有可視化,獨立一人編寫。希望有興趣的

    2023年04月08日
    瀏覽(22)

覺得文章有用就打賞一下文章作者

支付寶掃一掃打賞

博客贊助

微信掃一掃打賞

請作者喝杯咖啡吧~博客贊助

支付寶掃一掃領(lǐng)取紅包,優(yōu)惠每天領(lǐng)

二維碼1

領(lǐng)取紅包

二維碼2

領(lǐng)紅包