Spring Boot + SpringFoxでSwaggerを利用してソースからAPIキュメントを生成する - Qiita
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.8.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.8.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-core</artifactId> <version>2.8.0</version> </dependency> package com.exampl
Adding Examples
An API specification can include examples for: response MIME types, schemas (data models), individual properties in schemas. Examples can be used by tools and libraries, for instance, Swagger UI auto-populates request bodies based on input schema examples, and some API mocking tools use examples to generate mock responses. Note: Do not confuse example values with the default values. An example is
oneOf, anyOf, allOf, not
OpenAPI 3.0 provides several keywords which you can use to combine schemas. You can use these keywords to create a complex schema, or validate a value against multiple criteria. oneOf – validates the value against exactly one of the subschemas allOf – validates the value against all the subschemas anyOf – validates the value against any (one or more) of the subschemas Besides these, there is a not
REST APIのためのコード生成入門
Swagger Codegenは2015年以来注目を集めており、新興企業からIT複合企業に至る多くの企業が、製品の技術スタックの一部としてSwagger Codegenを利用してAPIクライアント、サーバースタブやAPIドキュメントの生成を行っています。(2018年2月時点でAPIクライアントは30以上の言語、サーバースタブは25以上のフレームワークをサポートしています) 本書はSwagger Codegenを活用してRESTful APIの開発を効率化する方法や、独自の要件を満たすために様々なオプションを使用して生成されるコードをカスタマイズする方法をご紹介します。 原著(English Version): https://gum.co/swagger_codegen_beginner 中国語版(简体中文版): https://gum.co/swagger_codegen_beginne
Authentication
OpenAPI uses the term security scheme for authentication and authorization schemes. OpenAPI 3.0 lets you describe APIs protected using the following security schemes: HTTP authentication schemes (they use the Authorization header): Basic Bearer other HTTP schemes as defined by RFC 7235 and HTTP Authentication Scheme Registry API keys in headers, query string or cookies Cookie authentication OAuth
[swaggo]GoのGoDocを書いたら、Swaggerを出せるやばいやつ - Qiita
swaggo 今回紹介するswaggoはyvasiyarov/swaggerにインスパイアを受けて、作成したOSSになります。現在、yvasiyarov/swaggerは開発が止まっているので、いくつかの問題が放置されたままになっています。（これはOSSなので仕方ないです） swaggoは元の構文をそのまま流用して、機能追加をしているものになります。 Swagger 2.0の対応 複雑な構造体の解析 カスタムヘッダー example value セキュリティ 私がざっと見た限り、上の内容はswaggoで無ければ使えないっぽいです。 Swagger便利だけど、書くのがそもそもだるい 最近になって、よくSwaggerというワードを目にするようになりました。これはとても画期的で、APIに実際にリクエストを投げれるドキュメントが出来上がります。 しかし、このドキュメントのコードを書くのが結構面倒！
![[swaggo]GoのGoDocを書いたら、Swaggerを出せるやばいやつ - Qiita](https://cdn-ak-scissors.b.st-hatena.com/image/square/64ad94339234c0b1b11c01b649a21f84bb137890/height=288;version=1;width=512/https%3A%2F%2Fqiita-user-contents.imgix.net%2Fhttps%253A%252F%252Fcdn.qiita.com%252Fassets%252Fpublic%252Farticle-ogp-background-412672c5f0600ab9a64263b751f1bc81.png%3Fixlib%3Drb-4.0.0%26w%3D1200%26mark64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTk3MiZoPTM3OCZ0eHQ9JTVCc3dhZ2dvJTVER28lRTMlODElQUVHb0RvYyVFMyU4MiU5MiVFNiU5QiVCOCVFMyU4MSU4NCVFMyU4MSU5RiVFMyU4MiU4OSVFMyU4MCU4MVN3YWdnZXIlRTMlODIlOTIlRTUlODclQkElRTMlODElOUIlRTMlODIlOEIlRTMlODIlODQlRTMlODElQjAlRTMlODElODQlRTMlODIlODQlRTMlODElQTQmdHh0LWFsaWduPWxlZnQlMkN0b3AmdHh0LWNvbG9yPSUyMzFFMjEyMSZ0eHQtZm9udD1IaXJhZ2lubyUyMFNhbnMlMjBXNiZ0eHQtc2l6ZT01NiZzPTk1NmQ2MzVjNjkzOTk1M2Q1YWQ4NDIxOTY1MGZmMzZm%26mark-x%3D142%26mark-y%3D57%26blend64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZoPTc2Jnc9NzcwJnR4dD0lNDBwZWkwODA0JnR4dC1jb2xvcj0lMjMxRTIxMjEmdHh0LWZvbnQ9SGlyYWdpbm8lMjBTYW5zJTIwVzYmdHh0LXNpemU9MzYmdHh0LWFsaWduPWxlZnQlMkN0b3Amcz1iMTFiNzM4YTliYTQ4MWFlMmNmYmJmOWQ4MjI0M2FhOQ%26blend-x%3D142%26blend-y%3D436%26blend-mode%3Dnormal%26txt64%3DaW4gSEFM44OX44Ot44Kw44Op44Of44Oz44Kw5ZCM5aW95Lya%26txt-width%3D770%26txt-clip%3Dend%252Cellipsis%26txt-color%3D%25231E2121%26txt-font%3DHiragino%2520Sans%2520W6%26txt-size%3D36%26txt-x%3D156%26txt-y%3D536%26s%3Dc5a92231c1d807fbbf9f5a6fe4ded06d)
API テクニカルガイドブック - 政府CIOポータル
API テクニカルガイドブック β版 平成 29 年 8 月 1 日 内閣官房情報通信技術（ＩＴ）総合戦略室 1 【目次】 １ 経緯及び目的..............................................................................................................................................................3 ２ API 設計時の留意事項...........................................................................................................................................4 ２．１ URI 設計及びリクエ
Bearer Authentication
Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The name “Bearer authentication” can be understood as “give access to the bearer of this token.” The bearer token is a cryptic string, usually generated by the server in response to a login request. The client must send this token in the Authorization header
Swagger、GraphQL、gRPC+Protocol Buffersの概観 - Qiita
この記事について この記事は、DroidKaigi2018の以下の発表に刺激を受けて書いた記事です。 まだAPI定義管理で消耗してるの？〜Swaggerを用いた大規模アプリ時代のAPI定義管理とコードジェネレート〜 すばらしきGraphQLのSEKAIへようこそ gRPCとProtocol Buffersで一味違うAndroid通信 上記の発表では、Swagger、GraphQL、gRPCとProtocol Buffersという言葉が出てきました。これらはサーバー/クライアント間のAPI通信を実現するために役立つものです。しかし、Swaggerはツール、GraphQLはクエリ言語、gRPCとProtocol Buffersは設計指針（を実装したライブラリ）とデータフォーマットというように同格に扱えるものではないので、ちょっと混乱してしまいます。 そこで、この記事ではサーバー/クライアント間
Swagger x Heroku で手軽に API モック＆ドキュメントを作る - Qiita
概要 Web、モバイル問わず、アプリケーション開発する際には、フロントエンドとバックエンド開発が一斉にスタートすることが多く、フロントエンド開発はバックエンド開発待ちになるケースがよくあります。この待ちの時に、フロントエンド側で仮で叩ける環境があると、実装をある程度進めることができ、開発が進みやすくなります。 この記事では Swagger と Heroku を用いて、 API のドキュメントとモック（スタブ）サーバーを手軽に作る方法を紹介します。 Swagger って？ Swagger は特定の書式で書くと API ドキュメントとかモックを良い感じで生成してくれるやつです。詳しい説明は公式ページをご参照ください。 手順 Swagger Editor で YAML 整形 モック＆ドキュメントのサーバーサイドコードを Generate する Heroku 用の修正をする Heroku にデプロ
Swagger3.0(OpenAPI Specification 3.0)で強化されたParameter Object - Qiita
Deleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article? 背景 2017/7にSwaggerはOpenAPI Specificationとして生まれ変わりました。 正確にはSwaggerの開発元(?)であるSMATRBEAR SoftwareがSwagger2.0をOpen API Initiativeに寄贈し、それを元にOpenAPI Specification（以下OAS） 3.0が作られました。 Swagger2.0と比較してOAS3.0では様々な拡張とリファクタリングが行われましたが、その中でParameter Objectについて記法がかなり拡張されたのでそれについて書きたいと思いま
Swagger x Heroku で手軽に API モック＆ドキュメントを作る - Qiita
概要 Web、モバイル問わず、アプリケーション開発する際には、フロントエンドとバックエンド開発が一斉にスタートすることが多く、フロントエンド開発はバックエンド開発待ちになるケースがよくあります。この待ちの時に、フロントエンド側で仮で叩ける環境があると、実装をある程度進めることができ、開発が進みやすくなります。 この記事では Swagger と Heroku を用いて、 API のドキュメントとモック（スタブ）サーバーを手軽に作る方法を紹介します。 Swagger って？ Swagger は特定の書式で書くと API ドキュメントとかモックを良い感じで生成してくれるやつです。詳しい説明は公式ページをご参照ください。 手順 Swagger Editor で YAML 整形 モック＆ドキュメントのサーバーサイドコードを Generate する Heroku 用の修正をする Heroku にデプロ
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
GitHub - nytimes/openapi2proto: A tool for generating Protobuf v3 schemas and gRPC service definitions from OpenAPI specifications
Flask-RESTPlusでREST APIとSwaggerドキュメントを統合 - Qiita
https://crash.academy/class/213
GitHub - philips/grpc-gateway-example
GitHub - LucyBot-Inc/api-spec-converter: Convert API descriptions between popular formats such as OpenAPI(fka Swagger), RAML, API Blueprint, WADL, etc.
まだAPI定義管理で消耗してるの？〜Swaggerを用いた大規模アプリ時代のAPI定義管理とコードジェネレート〜
GitHub - cam-inc/viron: OAS-driven Frontend-NoCode Administration Console
ローカル環境に Swagger のスタブサーバを立てる（Mac編） - Qiita
