tag swagger

標籤
貢獻18
95
03:10 PM · Nov 04 ,2025
jueqiangdeqianbi 頭像 reeli 頭像 xinliangcoder 頭像 vipbooks 頭像 kongxudexiaoxiongmao 頭像 linybjikezhilu 頭像 jdcdevloper 頭像 lmiky 頭像 huaweiclouddeveloper 頭像 bianmaqingnian 頭像 jeecg 頭像 apifox 頭像

@swagger / 博客 RSS 訂閱

jueqiangdeqianbi 頭像

倔強的鉛筆 - 從零開始學習 Swagger UI 的基本使用

在討論程序員職業生涯中的一些瑣碎但必須的任務時，眾所周知，編寫和維護文檔是他們最不喜歡的活動之一。程序員普遍不願意編寫註釋和文檔，同時又對那些沒有留下適當文檔的同事感到失望。這種矛盾主要是因為文檔管理是一個繁瑣的過程，且常見的情況是，即便 API 已更新，文檔仍處於未更新狀態，導致前後端開發同步問題頻發，浪費了寶貴的開發時間。 為了緩解這一問題，swagger已被廣泛採用。Swagger通過從代碼

swagger-ui , 程序員 , swagger , 後端 , 前端

收藏 評論

jeecg 頭像

JEECG低代碼平台 - JeecgBoot 如何在生產環境關閉 Swagger 文檔

為了生產安全，我們需要在生產環境關閉 JeecgBoot 的 Swagger 文檔功能。 介紹 JeecgBoot 作為一個低代碼開發平台，可以自動生成 OpenAPI 標準的 RESTful 協議的接口文檔，方便前後端分離式的開發模式，進行前後端對接，以及接口調試。 不過由於該開發通常情況下來説，僅限於開發環境、測試環境，不適用於生產環境、線上環境等，因為該文檔存在暴露系統內部信息的風險，一旦被

jeecg-boot , maven , 前後端分離 , profile , swagger

收藏 評論

u_17550480 頭像

Toobin - PostIn從初級到進階(6) - 如何導入swagger、OpenApi數據，實現數據遷移

PostIn 是一款開源免費的接口管理工具，工具支持一鍵安裝，頁面設計簡潔易用。本文將詳細介紹如何將swagger、OpenApi數據遷移到PostIn，以實現平滑切換。 1、創建項目 通過創建項目可以幫助開發團隊有效地集中管理項目相關的接口資源，使得團隊成員能夠快速查找和使用所需的 API 信息。 點擊項目→添加項目，可添加公共或者私

接口管理工具 , 文件上傳 , MySQL , 上傳 , openapi , 數據庫 , swagger

收藏 評論

vincent_5ad569c526768 頭像

vincent - golang gin 添加swagger文檔教程

前置準備 安裝 # 安裝 go get "github.com/swaggo/files" go get "github.com/swaggo/gin-swagger" go install github.com/swaggo/swag/cmd/swag@latest 給swagger配置路由 import swaggerFiles "github.com/swaggo/files"

接口文檔 , swagger , gin , go

收藏 評論

jueqiangdeqianbi 頭像

倔強的鉛筆 - @ApiModel和@ApiModelProperty註解的最佳實踐

在現代軟件開發中，提供清晰全面的 API 文檔 至關重要。@ApiModel 和 @ApiModelProperty 這樣的代碼註解在此方面表現出色，通過增強模型及其屬性的元數據來豐富文檔內容。它們的主要功能是為這些元素命名和描述，使生成的 API 文檔更加明確。 @ApiModel 和 @ApiModelProperty 的實際用例 這些註解不僅僅是為了展示；它們在各種情景中都發揮着實際的作用

JAVA , 接口文檔 , 程序員 , swagger , 後端

收藏 評論

reeli 頭像

橘子小睿 - 通過 Swagger 定義自動生成 Mock 數據

我最近的在做的項目是一個前後端分離的項目，前後端由不同的團隊分別開發，並且前端的進度經常領先後端。這就意味着，當前端在開發一個新功能時，API 可能還沒有準備好。不過，我們會先和後端先商議好 API Schema，然後使用 Mock 數據進行開發。 但問題也隨之而來，定義 Mock 數據並配置 mock server 真的太浪費時間了！我真的非常討厭這種沒有任何技術含量的「苦力活」。所以，只好想辦

mock , 前端工具 , swagger , 前端

收藏 評論

eolink 頭像

Eolink - JSON 格式的接口測試流程【Eolink Apikit】

在進行JSON格式的接口測試時，需要使用工具發送HTTP請求並獲取響應。測試工具可以是單獨的測試框架，如 Eolink Apikit。測試人員需要根據接口文檔和測試用例編寫測試腳本，然後運行測試並分析結果，以確保接口的質量和穩定性。 當我們後端需要從前端拿到這些JSON數據，我們應該如何測試自己的接口呢？今天就來淺淺探討一下JSON格式接口測試的流程。 1、JSON 格式的 API 導入

API , 測試 , swagger , 接口 , Json

收藏 評論

jueqiangdeqianbi 頭像

倔強的鉛筆 - 全方位掌握 Swagger 導出功能：入門教程

Swagger 是一個強大的平台，專門用於開發、構建和記錄 RESTful Web 接口。通過其提供的交互式用户界面，開發人員能夠輕鬆且迅速地創建和測試 API。Swagger 還允許用户以多種格式，包括 JSON 和 Markdown，導出 API 文檔。選擇 JSON 格式可以便於與其他應用或工具集成，而 Markdown 格式則更適合創建直觀、易於閲讀的文檔。 下面，我們將以Swagger

API , api文檔 , 程序員 , swagger , 後端

收藏 評論

reeli 頭像

橘子小睿 - 搭建前後端之橋

隨着前後端分離，開發的門檻降低了，我們不再要求團隊中的每個開發都是全棧工程師，這樣更容易找到項目的合適人選。團隊也劃分成了前端和後端兩個團隊。前端負責消費 API 並展示頁面，後端負責提供 API。這兩個團隊可以並行開發互不影響，大大提升了效率。雖然前後端分離解決了很多問題，但同時也帶來了新的困擾。 前後端分離帶來的困擾 溝通成本 前後端成為兩個獨立團隊之後，協作的問題便隨之而來。通過什麼來協作呢

前端工具 , swagger , typescript , 前端

收藏 評論

hushuosha 頭像

hushuosha - 還在用Postman？來，花2分鐘體驗下ApiPost的魅力

本文通過簡單介紹如何利用ApiPost調試接口和快速的生成接口文檔，讓您初步體驗ApiPost的魅力！ 1. API寫完想要測試？試試模擬發送一次請求 新建接口，我想模擬發送請求如下 curl --location --request POST 'https://echo.apipost.cn/get.php?c=Courseid=1000' \ --header 'User-Agent: Api

mock.js , apipost , postman , 接口文檔 , swagger

收藏 評論

jueqiangdeqianbi 頭像

倔強的鉛筆 - 使用 Swagger 自動生成 API 文檔的方法

對Tapir的深度剖析 利用Tapir，一個基於 OpenAPI規範 （也可稱作Swagger規範）的開源API設計工具，開發者可以通過一種高層級的抽象方式更輕鬆地構建和記錄RESTful API。 此工具以圖形化形式展示API端點及參數，並且配備了豐富的編輯選項及自動文檔生成能力，方便開發者生成清晰易懂的説明文件，並支持多種輸出格式如OpenAPI和Markdown等，從而適應各種不同的需求。

API , api文檔 , swagger , 接口 , 接口設計

收藏 評論

mylxsw 頭像

mylxsw - Lumen微服務生成Swagger文檔

作為一名phper，在使用Lumen框架開發微服務的時候，API文檔的書寫總是少不了的，比較流行的方式是使用swagger來寫API文檔，但是與Java語言原生支持 annotation 不同，php只能單獨維護一份swagger文檔，或者在註釋中添加annotations來實現類似的功能，但是註釋中書寫Swagger註解是非常痛苦的，沒有代碼提示，沒有格式化。 本文將會告訴你如何藉助phpst

lumen , php , laravel , phpstorm , swagger

收藏 評論

apifox 頭像

Apifox - API 管理工具遷移：從 Swagger 到 Apifox 的最佳實踐

如何將現有的 Swagger 管理的 API 遷移到 Apifox 呢？本文將為你提供詳細的遷移指南，介紹四種主要的方法： 導出 Swagger 文件並導入到 Apifox 通過在線鏈接定時導入 使用 IDEA 插件一鍵上傳 通過開放 API 導入 下面詳細介紹具體操作。 方法一 導出 Swagger 文件並導入 這是最直接的一種方法，適合於一次性遷移，尤其是當你的 API 文檔已經比

swagger-ui , API , api文檔 , 接口文檔 , swagger

收藏 評論

huobaodejianpan 頭像

火爆的鍵盤 - 學習 Swagger 中的 allOf 用法

Swagger 提供了一個名為allOf的特性，它是通過擴展已有的數據模型來構造更為複雜的數據結構的有效手段。這一特性主要用於數據模型的繼承及屬性的組合，有效減少了代碼重複，同時增強了代碼的可維護性與清晰度。訪問Swagger官方網站可以獲得更多關於Swagger的詳細信息。 應用場景 以下列舉了allOf特性的兩種主要應用場景: 模型繼承: 當數據模型之間存在層次結構，子模型需要承繼父模型

API , api文檔 , 程序員 , swagger , 後端

收藏 評論

xinliangcoder 頭像

程序員新亮 - Gin 實現自動生成接口文檔

自動生成接口文檔的好處 説之前，先説一下自動生成接口文檔有哪些好處？ 1）節省時間和工作量：手動編寫接口文檔是一項耗時且繁瑣的任務。通過自動生成接口文檔，可以大大減少編寫文檔的時間和工作量，提高開發效率。 2）保持文檔與代碼同步：代碼和文檔往往是不同步的，當代碼發生變更時，手動更新文檔可能容易出現遺漏或錯誤。自動生成接口文檔可以保持文檔與代碼的同步，確保文檔的準確性和實時性。 3）提供一致的文檔格

swagger , gin , go , 後端

收藏 評論

bianmaqingnian 頭像

編碼青年 - Apipost一站式API工具評測：整合Postman+Swagger+JMeter三大功能，打造全流程開發解決方案

作為一名Java開發者，始終追求開發過程的高效性。使用IntelliJ IDEA編寫代碼只是開始。一般來説，代碼完成後，我們會切換到Postman進行API調試。在確保API表現符合預期後，我們會使用Swagger為前端團隊生成文檔。最後，再使用JMeter進行性能和負載測試，以確保API工作流順暢且自動化。 Apipost=Postman + Swagger + JMeter 然而，這種多工具的

jmeter , apipost , postman , JAVA , swagger

收藏 評論

huaweiclouddeveloper 頭像

華為雲開發者聯盟 - SpringBoot寫後端接口，看這一篇就夠了！

摘要：本文演示如何構建起一個優秀的後端接口體系，體系構建好了自然就有了規範，同時再構建新的後端接口也會十分輕鬆。 一個後端接口大致分為四個部分組成：接口地址（url）、接口請求方式（get、post等）、請求數據（request）、響應數據（response）。如何構建這幾個部分每個公司要求都不同，沒有什麼“一定是最好的”標準，但一個優秀的後端接口和一個糟糕的後端接口對比起來差異還是蠻大的，

後台 , springboot , swagger

收藏 評論

jueqiangdeqianbi 頭像

倔強的鉛筆 - 簡單易懂：快速搭建 Swagger Mock 服務器的實用指南

本文適合讀者 編程新手及中級者 對 API 基礎有所瞭解的人士 想快速通過 OpenAPI 嘗試 Mock 服務器的人 本文目的 指導讀者建立模擬服務器環境 探索 Swagger 的使用方法 學習如何使用 OpenAPI 編制特定的 API 設計 OpenAPI概述 官方文檔描述如下： OpenAPI規範（原稱Swagger規範）是一種用於REST API的API描述格式。

mock , 程序員 , swagger , 後端 , 前端

收藏 評論

lmiky 頭像

noname - 【小知識】springdoc的swagger-config顯示404問題

1. 問題 項目環境 jdk:21 springboot:3.2.3 springcloud:2023.0.0 springdoc-openapi-starter-webmvc-ui:2.5.0 項目引入了springdoc，本地開發測試時，http://localhost:8080/swagger-ui/index.html頁面也能正常打開；發佈到測試環境之後，通過

springcloud , springboot , JAVA , swagger , springdoc

收藏 評論

jueqiangdeqianbi 頭像

倔強的鉛筆 - 如何用 Go 自動生成 Swagger 文檔：完全指南

在開發 RESTful API 的過程中，確保其易於理解和使用對於提升團隊協作和產品質量至關重要。OpenAPI（原名Swagger）規範框架提供了一套標準，旨在簡化 API 的設計、構建、測試和管理。本文將深入探討 OpenAPI 3.0 和 Swagger 2.0 規範，並介紹在 Go 語言生態中相關的開源項目。 對比 OpenAPI 3.0 與 Swagger 2.0 Swagger 2.0

API , api文檔 , JAVA , 接口文檔 , swagger

收藏 評論

jdcdevloper 頭像

京東雲開發者 - 用Rust生成Ant-Design Table Columns | 京東雲技術團隊

經常開發表格，是不是已經被手寫Ant-Design Table的Columns整煩了？ 尤其是ToB項目，表格經常動不動就幾十列。每次照着後端給的接口文檔一個個配置，太頭疼了，主要是有時還會粘錯就尷尬了。 那有沒有辦法能自動生成columns配置呢？ 當然可以。 目前後端的接口文檔一般是使用Swagger來生成的，Swagger是基於OpenAPI規範的一種實現。（OpenAPI規範是一種描述RE

column , rust , cli , swagger , 後端

收藏 評論

linybjikezhilu 頭像

linyb極客之路 - 高效解析 Swagger，輕鬆優化接口平台發佈流程，你還不知道？

在接口平台的功能優化之路上，我們一直致力於探索如何讓接口提供方能夠更便捷地將接口信息發佈到平台。經過一番深入調研，我們驚喜地發現，公司絕大多數項目都引入了 Swagger，這一發現為我們開啓了新的優化思路 —— 通過解析 Swagger 來實現接口信息的高效收集與發佈。起初，我們以為解析工作不過是小菜一碟，上手後才發現，雖然解析本身並不複雜，但對象的組裝過程卻相當繁瑣。不過，幸運的是，我們找到了一

swagger

收藏 評論

kongxudexiaoxiongmao 頭像

用户bPc5q3Z - 軟件測試/測試開發/全日制/測試管理丨後端接口文檔管理Swagger

Swagger 是一種用於 API 文檔生成和管理的工具，它支持多種編程語言和框架。通過使用 Swagger，你可以創建一個可交互的、易於理解的 API 文檔，方便前端開發人員和其他團隊成員理解和使用你的後端 API。 以下是使用 Swagger 進行後端接口文檔管理的一般步驟： 集成 Swagger 到後端項目： 你需要在後端項目中添加 Swagger 的依賴庫。對於不同的編程語言和框架，

軟件測試 , 測試開發 , swagger , 接口

收藏 評論

jueqiangdeqianbi 頭像

倔強的鉛筆 - Django 整合 Swagger：實現快速 API 文檔生成

Django ，作為 Python 編寫的一個優秀的開源 Web 應用框架，特別適用於快速開發的團隊。對於很多場景來説，我們需要一份 API 文檔，好處實在太多了： 提高開發效率：開發者可以基於 API 文檔 快速學習和嘗試 API，同時 Swagger 文件也可以在許多不同的平台上從代碼註釋中自動生成，減少了手動編寫文檔的時間和精力。 方便接口測試：基於 API 文檔可以生成客户端 SDK

web開發 , django , 程序員 , swagger , 前端

收藏 評論