typespec.io
April 25, 2024Introducing TypeSpec: A New Language for API-Centric Development Over last few years, we’ve been hard at work on https://typespec.io/, a modern API definition language. This language is designed to meet the evolving needs of API developers, architects, and managers in an environment where the delivery of consistently high-quality APIs and related experiences is becoming increasingly
OpenAPIã§APIドã‚ュメントをåˆã‚ã¦ä½œã‚‹ã¨ãã«èªã‚€è³‡æ–™
OpenAPIを使ã£ã¦APIドã‚ュメントをåˆã‚ã¦ä½œã‚‹ã¨ãã«å‚考ã«ãªã£ãŸè³‡æ–™ã‚’ã¾ã¨ã‚ã¾ã—ãŸã€‚ 最åˆã«èªã‚€è³‡æ–™ Swagger ã§ã¯ãªã„ OpenAPI Specification 3.0 ã«ã‚ˆã‚‹ API サーãƒãƒ¼é–‹ç™º OpenAPIã¨ã¯ãªã‚“ãžã‚„？ã™ã“ã—å‰ã«è©±é¡Œã«ãªã£ãŸSwaggerã¨ã®é•ã„ã¯ï¼Ÿã©ã®ã‚ˆã†ã«æ›¸ã„ã¦ã„ã‘ã°è‰¯ã„？ãªã©ã‚’ã–ã£ãã‚Šé ã«å…¥ã‚Œã‚‰ã‚Œã‚‹è³‡æ–™ã§ã™ã€‚ スã‚ーマファースト開発ã®ãŸã‚ã®OpenAPI（Swagger）è¨è¨ˆè¦ç´„ ã–ã£ãり記法ãŒåˆ†ã‹ã‚‹è¨˜äº‹ã§ã™ã€‚OpenAPIã¯yamlファイルã§ã®è¨˜è¿°ãŒåŸºæœ¬ã§ã™ãŒã€å¾Œè¿°ã™ã‚‹ Stoplight Stadio ã¨ã„ã†GUIエディターを使ã†ã¨ã€æ¯”較的楽ã«ä½œæˆç®¡ç†ãŒã§ãã¾ã™ã€‚ エラーレスãƒãƒ³ã‚¹ OpenAPIã¨ã„ã†ã‚ˆã‚ŠAPIãã®ã‚‚ã®ã®ã‚¨ãƒ©ãƒ¼ãƒ¬ã‚¹ãƒãƒ³ã‚¹ã®è¨è¨ˆæ€æƒ³ã«ã¤ã„ã¦ã§ã™ã€‚ REST API Error Handling Best Practices
本当ã«ä½¿ã£ã¦ã‚ˆã‹ã£ãŸOpenAPI (Swagger) ツール | フューãƒãƒ£ãƒ¼æŠ€è¡“ブãƒã‚°
サードパーティ製ã®ãƒ„ール本家ã‹ã‚‰ã¯ä¸Šè¿°ã®ãƒ„ールãŒæä¾›ã•ã‚Œã¦ã„ã¾ã™ãŒã€ã‚µãƒ¼ãƒ‰ãƒãƒ¼ãƒ†ã‚£è£½ã®æ§˜ã€…ãªãƒ„ールãŒä¸–ã®ä¸ã«ã¯å˜åœ¨ã—ã¾ã™ã€‚ エコシステムãŒæˆç†Ÿã—ã¦ã„ã‚‹ã®ã‚‚Swaggerを利用ã™ã‚‹ãƒ¡ãƒªãƒƒãƒˆã®1ã¤ã§ã™ã。 https://openapi.tools/ 冒é ã®ã¨ãŠã‚Šã€ã“ã®ã‚µãƒ¼ãƒ‰ãƒ‘ーティ製ã®ãƒ„ールã®ä¸ã§å®Ÿéš›ã«åˆ©ç”¨ã—ã¦è‰¯ã‹ã£ãŸãƒ„ールを3ã¤ã”紹介ã—ãŸã„ã¨æ€ã„ã¾ã™ã€‚ Stoplight Studiohttps://stoplight.io/studio/ 1ã¤ç›®ã®ãƒ„ールã¯ã€ŒStoplight Studioã€ã¨ã„ã†API仕様を記載ã™ã‚‹ãŸã‚ã®GUIエディタã¨ãªã‚Šã¾ã™ã€‚ 今ã¾ã§Swagger Editorを利用ã—ã¦YAMLを書ã„ã¦ã„ãŸãã“ã®ã¿ãªã•ã‚“ã€YAMLç‹åŠ›ã¯ã‚‚ã†å¿…è¦ã‚ã‚Šã¾ã›ã‚“。 Design APIs 10x faster ã®è¬³ã„æ–‡å¥ã©ãŠã‚Šã€Stoplight Studioを使ãˆã°GUIã§ç›´æ„Ÿçš„ã«ã€é«˜é€Ÿ
スã‚ーマ定義言語 Protocol Buffers 㨠protoc-gen-swagger を使ã£ã¦ Web API ã®ã‚¹ã‚マを埋ã‚よㆠ- VOYAGE GROUP techlog
VOYAGE Lighthouse Studio ã®æµ·è€åŽŸ (@co3k) ã§ã™ã€‚先日 30 æ³ã«ãªã£ãŸè¨˜å¿µã¨ã—ã¦ã‚¿ã‚¤ãƒˆãƒ«ã¯ã‚ªãƒ¤ã‚¸ã‚®ãƒ£ã‚°ã§ã™ã€‚ ã•ã¦ã€æ™®æ®µã¯ 神ゲー攻略 ã¨ã„ã†ã‚²ãƒ¼ãƒ 攻略サイトをé‹å–¶ã—ã¦ã„ã‚‹ã®ã§ã™ãŒã€ã¨ã‚る派生サービスを立ã¡ä¸Šã’ã‚‹ã«ã‚ãŸã‚Šã€ Web API スã‚ーマ定義を gRPC ã«åŸºã¥ãå½¢å¼ã® Protocol Buffers ã§æ›¸ã〠protoc-gen-swagger プラグインを介ã—㦠OpenAPI 定義ファイルã¨ã—ã¦ç”Ÿæˆã™ã‚‹ã€ã¨ã„ã†ã‚¢ãƒ—ãƒãƒ¼ãƒã‚’採りã¾ã—ãŸã€‚ yugui ã•ã‚“ã®ç´ 晴らã—ã„記事ã€ã€Œä»Šã•ã‚‰Protocol Buffersã¨ã€æ‰‹ã«é¦´æŸ“ã‚€é“å…·ã®è©±ã€ã«ã‚ˆã£ã¦ã‚¹ã‚ーマ定義言語ã¨ã—ã¦ã® Protocol Buffers ãŒã«ã‚ã‹ã«æ³¨ç›®ã‚’æµ´ã³ã¦ä»¥é™ã€ä¼¼ãŸã‚ˆã†ãªã“ã¨ã‚’ã‚„ã‚ŠãŸã„ã¨ã„ã†æ–¹ã‚‚ã„らã£ã—ゃるã®ã§ã¯ãªã„ã§ã—ょã†ã‹ã€‚ ã¨ã“ã‚ãŒã€ãŠãらãå˜ä½“㧠protoc-g
Swagger ã«ã¤ã„ã¦ã®è¦šæ›¸ - Qiita
Swagger ã§è¦šãˆãŸã“ã¨ã€ãƒãƒžã£ãŸã“ã¨ã‚’メモã—ã¦ã„ã Swagger 㨠JSON schema ã®ä½ç½®ã¥ã‘ Swagger 㯠API を定義ã™ã‚‹ãŸã‚ã®ã‚‚ã® JSON schema 㯠JSON ã®ãƒ‡ãƒ¼ã‚¿æ§‹é€ を定義ã™ã‚‹ãŸã‚ã®ã‚‚ã® JSON Hyper-Schema ã‚‚ API を定義ã™ã‚‹ãŸã‚ã®ã‚‚㮠対比ã™ã‚‹ã¨ã—ãŸã‚‰ Swagger <-> JSON Hyper-Schema Swagger <-> JSON schema ã§ã¯ãªã„ ç¾ã« Swagger ã®åž‹å®šç¾©ã¯ JSON schema ãŒä½¿ã‚ã‚Œã¦ã‚‹ Swagger 㨠JSON Hyper-Schema ã®æ¯”較 Pros swagger-ui ã‹ã£ã“ã„ã„ codegen ã«è¨€èªžã„ã£ã±ã„ Cons JSON Schema æº–æ‹ ã¨ã¯ãªã‚“ã ã£ãŸã®ã‹ JSON Schema ã®æŠ½å‡ºã—ã¦ãれるやã¤ãŒãªã„ committee ãŒãªã„ ドã‚ュメ
swagger-playã§APIドã‚ュメントを自動生æˆã™ã‚‹ - Qiita
æ¦‚è¦ ãƒ•ãƒãƒ³ãƒˆã‚¨ãƒ³ã‚¸ãƒ‹ã‚¢ã‚„外部ã«å…¬é–‹ã™ã‚‹APIを用æ„ã™ã‚‹æ™‚ã€APIドã‚ュメントを書ãã®ã¯åœ°å‘³ã«é¢å€’ã§ã™ã‚ˆã。 最近ã§ã¯swaggerã‚’ç†é ã«ã€ãƒ‰ã‚ュメント生æˆãƒ„ール（Mockサーãƒãƒ¼ã‚‚内蔵ã—ã¦ã„ã‚‹ã‚‚ã®ã‚‚ã‚る）ãŒå……実ã—ã¦ãã¦ã„ã‚‹ã®ã§ã€ãれを使ã£ã¦ã„ã„æ„Ÿã˜ã«ãƒ‰ã‚ュメントを作りãŸã„ã¨æ€ã„ã¾ã™ã€‚ play2ã‚‚swagger pluginãŒã‚ã‚‹ã®ã§ã€ãれを使ã£ã¦ãƒ‰ã‚ュメント生æˆã‚’コードå´ã§ã‚„ã£ã¦ã—ã¾ã„ã¾ã—ょã†ã€‚ （ç†è€…ã¯swaggerを使ã£ãŸã“ã¨ãŒãªã‹ã£ãŸã®ã§ã€swagger自体ã®ä½¿ã„方もå«ã‚“ã 記事ã«ãªã‚Šã¾ã™ã€‚） 環境 （執ç†æ™‚点ã§ã¯ã€swagger-playãŒplay2.5対応ã—ãã‚Œã¦ã„ãªã‹ã£ãŸã®ã§ã€forkã•ã‚ŒãŸã‚‚ã®ã‚’使用ã—ã¦ã„ã¾ã™ï¼‰ Play 2.5 swagger-play (CreditCardsComãŒforkã—ãŸã‚‚ã®) ソースコードã¯ã“ã¡ã‚‰ ゴール （アノテーションベースã§ï¼‰ã‚る程度ã‚
Play Frameworkã§Swaggerを使ㆠ- Qiita
Swaggerã¯JSON API用ã®ãƒ‰ã‚ュメンテーション作æˆãƒ„ールã§ã™ã€‚ http://swagger.io/ http://petstore.swagger.wordnik.com/ ã“ã‚“ãªç”»é¢ãŒç”Ÿæˆã•ã‚Œã¦ã€ç”»é¢ã®ä¸‹ã®æ–¹ã«ã‚ã‚‹"Try it out"ã¨ã„ã†ãƒœã‚¿ãƒ³ã§å®Ÿéš›ã«ãƒªã‚¯ã‚¨ã‚¹ãƒˆã‚’é€ä¿¡ã™ã‚‹ã“ã¨ãŒã§ãã¾ã™ã€‚ Swaggerã¨Play Framework 上ã®ç”»é¢ã¯Swagger UIã¨ã„ã†HTML+JavaScriptã®ãƒ„ールã«ã‚ˆã‚‹ã‚‚ã®ã§ã€Swaggerã®å®Ÿä½“ã¯ã‚³ãƒ¼ãƒ‰ã‚¢ãƒŽãƒ†ãƒ¼ã‚·ãƒ§ãƒ³ã‚’解釈ã—ã¦ã‚¨ãƒ³ãƒ‰ãƒã‚¤ãƒ³ãƒˆã«é–¢ã™ã‚‹JSONã‚’è¿”ã—ã¦ãれるツールã§ã™ã€‚ Swaggerã®ãƒ¡ã‚¤ãƒ³ãƒªãƒã‚¸ãƒˆãƒªã§ã‚ã‚‹Swagger Coreã¯Scalaã§æ›¸ã‹ã‚Œã¦ã„ã¦ã€Play Frameworkã®ç”¨ãƒ©ã‚¤ãƒ–ラリもSwagger Coreã®ãƒªãƒã‚¸ãƒˆãƒªå†…ã«ã‚ã‚Šã¾ã™ã€‚ Play Framworkã§Swaggerを使ã†ã‚µãƒ³ãƒ—ルアプ
swaggerã§APIドã‚ュメントを書ã„ãŸã‚‰ã‚ã£ã¡ã‚ƒã¯ã‹ã©ã£ãŸè©± - kaz29
Swaggerã¯ã€REST APIã®ä»•æ§˜ã¨ãã‚Œã«é–¢é€£ã™ã‚‹ãƒ„ール群ã®ç·ç§°ã§ã™ã€‚REST APIã®ä»•æ§˜ã‚’定義ã—ãŸJSONファイル(Swagger Spec)を軸ã«ä»¥ä¸‹ã®ã‚ˆã†ãªãƒ„ールã‹ã‚‰æ§‹æˆã•ã‚Œã¦ã„ã¾ã™ã€‚ Swagger UI - Swagger Spec ã‹ã‚‰å‹•çš„ã«APIドã‚ュメントを生æˆã™ã‚‹ãƒ„ール Swagger Editor - Swagger Specã®ã‚¨ãƒ‡ã‚£ã‚¿ Swagger Codegen - Swagger Specã‹ã‚‰ã‚¯ãƒ©ã‚¤ã‚¢ãƒ³ãƒˆã®ã‚³ãƒ¼ãƒ‰ã‚’生æˆã™ã‚‹ãƒ„ール 最近ã§ã¯ã€Open API InitiativeãŒAPIã®è¨˜è¿°ã®ãŸã‚ã«Swaggerを採用ã—ã¦è©±é¡Œã«ãªã‚Šã¾ã—ãŸã€‚ www.publickey1.jp APIドã‚ュメントã®ãƒ¡ãƒ³ãƒ†ã¯çµæ§‹é¢å€’ 一般的ã«APIã®ä»•æ§˜æ›¸ã¯ã€å¤ãã¯Excel/Wordãªã©ã‚’使ã£ãŸã‚Šã€æœ€è¿‘ã§ã¯Wikiã‚„Markdownå½¢å¼ã§è¨˜è¿°ã—ãŸã‚Šãªã©ãƒ—ãƒã‚¸ã‚§ã‚¯ãƒˆã«ã‚ˆã£ã¦
Swaggerã¨ã¯ä½•ã‹ï¼Ÿ - プãƒã‚°ãƒ©ãƒžã§ã‚ã‚ŠãŸã„
最近ã€Swaggerã¨ã„ã†å˜èªžã‚’èžã機会ãŒå¢—ãˆã¦ã„ã¾ã›ã‚“ã‹ï¼ŸMicrosoftã‚„Google,IBMãŒã€REST APIã®è¨˜è¿°æ¨™æº–化を目指ã—ãŸã€ŒOpen API Initiativeã€ã¨ã„ã†å›£ä½“ã‚’ç«‹ã¡ä¸Šã’ã€ãã®ãƒ™ãƒ¼ã‚¹ã‚’Swaggerを利用ã™ã‚‹ã¨ã„ã†ã“ã¨ã§ä¸€èºæ³¨ç›®ã‚’集ã‚るよã†ã«ãªã‚Šã¾ã—ãŸã€‚ã—ã‹ã—ã€Swaggerã¨ã„ã†ã‚‚ã®ã‚’調ã¹ã‚‹ã¨ãƒ„ールã®è©±ã‚„ドã‚ュメントã®è©±ãŒå‡ºã¦ãã¦ã€ä½•ãªã®ã“ã‚Œã¨ãªã‚‹ã“ã¨ãŒå¿…定ã§ã™ã€‚ã¨ã„ã†ã“ã¨ã§ã€WebAPIã¨ã¯åˆ‡ã£ã¦ã‚‚切れãªã„関係ã®Swaggerã®è©±ã‚’ç°¡å˜ã«ã—ã¦ã¿ã¾ã™ã€‚ Swaggerã¨ã¯ï¼Ÿ Swaggerã¨ã¯ã€ä¸€ç¾©çš„ã«ã¯REST APIを記述ã™ã‚‹ç‚ºã®ä»•æ§˜ã§ã™ã€‚当åˆã‹ã‚‰ã€SwaggerãŒæ¨™æº–ã®ä»•æ§˜ã«ãªã‚‹ã“ã¨ã‚’目指ã—ã¾ã™ã‚ˆã¨å®£è¨€ã—ã¦ã„ã¦ã€ç±³å›½ç‰ã§ã¯ãƒ‡ãƒ•ã‚¡ã‚¯ãƒˆãƒ»ã‚¹ã‚¿ãƒ³ãƒ€ãƒ¼ãƒ‰ã¨ãªã£ã¦ã„ã¾ã—ãŸã€‚ãã‚ŒãŒã€ã€ŒOpen API Initiativeã€ãŒå‡ºæ¥ãŸã“ã¨ã«ã‚ˆã‚Šã€å®Ÿéš›ã«æ¨™æº–ã®ä»•æ§˜
1
ランã‚ング
ãŠçŸ¥ã‚‰ã›
ランã‚ング
リリースã€éšœå®³æƒ…å ±ãªã©ã®ã‚µãƒ¼ãƒ“スã®ãŠçŸ¥ã‚‰ã›
最新ã®äººæ°—エントリーã®é…ä¿¡
j次ã®ãƒ–ックマーク
kå‰ã®ãƒ–ックマーク
lã‚ã¨ã§èªã‚€
eコメント一覧を開ã
oページを開ã
Open API Initiative Announces Release of the OpenAPI Spec v3 Implementer’s Draft - OpenAPI Initiative
IT-Beratung und agile Softwareentwicklung | Novatec
GitHub - swagger-api/swagger-codegen: swagger-codegen contains a template-driven engine to generate documentation, API clients and server stubs in different languages by parsing your OpenAPI / Swagger definition.
GitHub - springfox/springfox: Automated JSON API documentation for API's built with Spring
{{#tags}}- {{label}}
{{/tags}}