在寫Web API 的時候,通常也需要提供清晰明瞭的文件供對接者查看,不過撰寫文件需要花非常多時間,也必須制定出文件規範才能讓對接的使用者容易明瞭,~~而且工程...
本文將介紹如何使用 JWT 保持登入狀態,配合 Swagger / OpenAPI 呈現。 .NET Framework 4.7.2 開發環境 Visual...
2023/05/23 更新: 為了避免本文章散落在不同網站,之後統一由部落格更新,再麻煩從部落格查看~ 本文章同時發佈於: Github(包含程式碼)...
前言 今天我們要來學如何建立Web API,並利用Postman進行API的測試,最後安裝Swagger套件來產生API的說明文件。與WebService相比,...
Introduction Swagger is a powerful open source framework that helps you design,...
在nestjs下可以用類似ASP.net core或是Java中類似的reflection機制方式,利用Decorators及Swagger Module自動產...
我們通常會建立一個服務來讓模型上線,但在上線前,有一些基本的網路知識需要先了解。因此前面會先淺談網路,後面會介紹 FastAPI 來部署模型。 淺談網路 超文本...
這是Swagger的Logo這是SWAG的Logo 大家要小心不要Google錯了 介紹 Swagger是SmartBear Software的API開發人員套...
耶,這篇是我想要寫很久的,終於到swagger了另外NestJS相關系列包含這篇,應該…九篇吧!吧! 到Day50剛好把NestJS講完的話,有種很舒服的感覺(...
網路上 API 文件都那麼完整,為什麼我們公司的都... 什麼!?這次文件應該是我負責?誒,我還沒寫過文件啊~~~ Swagger 算是目前相當主流的 API...
Abstract 我們前面講了許多Spring應用開發,但當我們開發好一套系統,勢必要有一套API手冊,不然前端開發者就會很辛苦的難以開發,都要等待您的API出...
原文: https://j2hongming.github.io/2021/08/06/view-open-api-in-local/ open API類似原始...
前言:大家都知道在測試API資料的時每次都要重打一次request的要求很麻煩,而Swagger不但可以幫我取代以前要用Postman的麻煩,可以讓我快速的測試...
先定義一個 Attribute [AttributeUsage(AttributeTargets.Method, AllowMultiple = true)]...
連結點我:curlConverter 一般的 swagger 文件在執行 post、put、patch、delete 後,都會顯示一段 curl 指令。上述範例...
前言 最近接了一個急案,沒辦法浪費太多時間在API的開發上。因緣際會下得知了EF Core這個方便的工具,它可以快速地建立Model,再搭配Scaffoldin...
在上一篇文章中,我們學習了如何修改Django項目的資料庫結構,並探討了MariaDB的使用方法。本篇文章中,我們將探討如何設置Django Admin管理系統...
由於我想設計一個 API 完成不同種類發票的功能,包含 登錄紙本電子發票 登錄傳統發票 登錄個人載具 Schema 那要怎麼實作呢?首先是設計 Schema...
我:「我不想寫文件!」也是我:「為什麼沒有文件!」身為一個 Web 後端工程師,既然不可能不寫文件,如何讓文件更好寫?本系列文將針對 Web API 的文件撰...
OpenAPI 的資料型別(type)是基於 Json 擴充,基礎型別有 boolean、integer、number、string......等,並可藉由...
昨天探討了 Web API 文件要有的內容,OpenAPI 提供了標準化的規範,讓開發者能夠以 json 或 yaml 格式來描述 API 規格。不少開發者都...
完成服務的基本描述後,就可以針對各支 API 內容進行撰寫了。同樣以虛構的會員服務為範例,以下是一支「取得單一會員資訊 API」的 OpenAPI 規格: #...
一般在做 API 設計時,都會盡量收斂設計,期望一組 API 不用太多支,每支 API 參數和欄位不要太複雜,希望這些 API 可以像最經典的樂高積木一樣小而...
在多數的情境下,不會獨立存在一支 API,而是由一組 API 來對領域或資源進行存取,以會員服務來說,會有一組包含:註冊、異動、註銷、取得單筆、查詢多筆......
前言今天想針對互動式的 API 文件,進行分享。開發時,常遇到需要先提供規格(request、response),並可以直接在瀏覽器上測試 API 等需求,最早...
Hello 大家好,我是Winnie今年遇到了好同事?!推坑後,燃起了今年參加鐵人賽 雖然網路上有好多教學,不過希望這次可以帶給大家更多如何建立專案的概念,希...
今天將介紹 TypeSpec 的基礎型別,接著說明如何將其使用在操作的參數和回傳中。 型別 數值 和 OpenAPI 一樣,TypeSpec 支援許多不同的數...
Hello ~ 大家好,經過了前面幾天的練習後,是不是可以慢慢開發出API了呢 ? 那如果我們API愈來愈多,或是後端團隊要提供給前端團隊API文件,又或著是要...
命名空間 在 TypeSpec 中可使用命名空間 namespace 來分類類型,透過這樣的方式可以組織不同類型,也可以避免命名衝突,範例程式碼如下: nam...
模型 多型 接下來將使用在 [Day 06] OpenAPI:標準的 API 描述技術規範(五) 時相同的情境做說明。會員允許多種登入方式,而透過不同的登入方...