在寫Web API 的時候,通常也需要提供清晰明瞭的文件供對接者查看,不過撰寫文件需要花非常多時間,也必須制定出文件規範才能讓對接的使用者容易明瞭,~~而且工程...
OpenAI API- ChatGPT + Whisper 讓你快速抓到重點 最近2023 Global AI Bootcamp 才剛剛圓滿落幕,而我也有幸籌辦...
先前有提到整個 OpenAPI 的運作流程是… 開發者為 route 撰寫 OpenAPI definition Generator 根據 OpenAPI S...
Web API 測試可以是後端工程師使用測試框架撰寫白箱測試,也可以是 QA 使用測試工具進行黑箱測試。對於後端工程師來說,如果 API 有異動,很容易找出對應...
Spring Boot 使用 Annotation 撰寫 OpenAPI Definition 我們先來看 spring boot 撰寫 OpenAPI def...
本文目標 認識 SBI 認識 OpenAPI Service Based Interface SBI 是由 3GPP 提出的 interface,除了 UP...
熟悉JWT的我敲開了大門的門鎖,走進了房間 同學:來,你過來~~ 我:幹嘛啦 (被推著坐下),哇,同學你有好多資料喔~! 同學:這沒什麼,來,來看這個好康的(送...
為什麼我想自己實作 Ktor OpenAPI Generator? 大多數的 Web 框架都有官方或社群開發的 OpenAPI Generator,自動把程式碼...
在串接API之前我們還有一個重要的設定要做,我們必須先匯出證交所網站的SSL證書,並加入到JAVA的驗證裡面。 先進入證交所openAPI首頁 瀏覽器取得憑證...
[Day 21] API 2.0: 如何從雲端獲得資訊 ? (12min)-- Application Programming Interface 應用程式...
不考慮自己使用第三方服務或是用 Firebase 進行資料串接之下,先想一下你的目的想要呈現什麼?你是玩什麼樣的資料?你對什麼主題有興趣?還是想要應用這些資料做...
前情提要 在前面的挑戰中,我們曾經體驗過Mock Serivces,可以在前後端討論出介面之後,根據規格開始各自的工作。那麼問題來,怎樣的介面才能讓前後端都能夠...
我:「我不想寫文件!」也是我:「為什麼沒有文件!」身為一個 Web 後端工程師,既然不可能不寫文件,如何讓文件更好寫?本系列文將針對 Web API 的文件撰...
OpenAPI 的資料型別(type)是基於 Json 擴充,基礎型別有 boolean、integer、number、string......等,並可藉由...
完成服務的基本描述後,就可以針對各支 API 內容進行撰寫了。同樣以虛構的會員服務為範例,以下是一支「取得單一會員資訊 API」的 OpenAPI 規格: #...
昨天探討了 Web API 文件要有的內容,OpenAPI 提供了標準化的規範,讓開發者能夠以 json 或 yaml 格式來描述 API 規格。不少開發者都...
一般在做 API 設計時,都會盡量收斂設計,期望一組 API 不用太多支,每支 API 參數和欄位不要太複雜,希望這些 API 可以像最經典的樂高積木一樣小而...
在多數的情境下,不會獨立存在一支 API,而是由一組 API 來對領域或資源進行存取,以會員服務來說,會有一組包含:註冊、異動、註銷、取得單筆、查詢多筆......
今天將介紹 TypeSpec 的基礎型別,接著說明如何將其使用在操作的參數和回傳中。 型別 數值 和 OpenAPI 一樣,TypeSpec 支援許多不同的數...
命名空間 在 TypeSpec 中可使用命名空間 namespace 來分類類型,透過這樣的方式可以組織不同類型,也可以避免命名衝突,範例程式碼如下: nam...
模型 多型 接下來將使用在 [Day 06] OpenAPI:標準的 API 描述技術規範(五) 時相同的情境做說明。會員允許多種登入方式,而透過不同的登入方...
手刻 yaml 或 json 文件讓寫 OpenAPI 文件相當不方便,透過 Swagger Editor 或 Stoplight 等 UI 輔助工具是一種選...
在開始之前,先簡單介紹一下昨日我們建立的專案及基本操作。初始化 TypeSpec 專案時產生的 main.tsp 檔是 TypeSpec 的預設進入點,CLI...
模型 使用關鍵字 model 建立模型,模型可以在不同的操作或其他模型中重複使用,編譯時模型會輸出在 components 節點,並在各個使用的地方透過 $r...