MicroProfile OpenAPIによるAPI管理（Part2）：MicroProfile OpenAPI annotationを利用しドキュメント化する｜富士通技術者ブログ～Javaミドルウェア～
MicroProfile OpenAPIによるAPI管理（Part2）：MicroProfile OpenAPI annotationを利用しドキュメント化する 富士通技術者ブログ～Javaミドルウェア～ 2020年5月15日 初版 数村 憲治 コードとドキュメントの不一致問題 新しくコードを作成する際には、ドキュメントを作ることは多いですが、コードを修正する際に必ずしも毎回ドキュメントが更新されず、いつのまにか、コードとドキュメントが乖離しているということになっていないでしょうか？これは、マイクロサービスに限った話しではなく昔からある問題ですが、対応方法についても昔からいろいろ考えられてきました。その中で、現在もっとも成功しているやり方の一つとしてJavadocがあります。 JavadocはJavaソースのコメント中にタグを使って、クラス、メソッド、変数などの情報を記載し、javadoc
API Keys
OAS 3 This page applies to OpenAPI 3 – the latest version of the OpenAPI Specification. If you use OpenAPI 2 (fka Swagger), visit OpenAPI 2 pages. Some APIs use API keys for authorization. An API key is a token that a client provides when making API calls. The key can be sent in the query string: GET /something?api_key=abcdef12345 or as a request header: GET /something HTTP/1.1 X-API-Key: abcdef12
OpenAPI Generatorに適したOpenAPIの書き方 - ZOZO TECH BLOG
はじめに こんにちは！ WEARバックエンドブロックの高久です。 WEARではOpenAPI（Swagger）を使って、アプリやWebのクライアントが利用するAPIを定義しています。そして先日、開発効率化のためにOpenAPI GeneratorでOpenAPIからAPIクライアントコードを自動生成、活用できるように整備をしました。その中でOpenAPI Generatorに適したOpenAPIの書き方のポイントがいくつかあったので、内容を紹介していきます。 想定読者 OpenAPIを現在利用している、またはこれから利用する予定の方 OpenAPI Generatorを利用したコード自動生成を検討している方 背景 当初WEARではAPIクライアントコードはOpenAPIでのAPI定義を基に各クライアントが手動で実装していました。しかし手動で実装すると初期の実装コストや変更時の追従コストがか
開発効率を上げる！Swaggerの記法まとめ - ZOZO TECH BLOG
この記事ではOpenAPI Specification v2に関する内容を取り上げています。しかし、2023年9月現在での最新の仕様はOpenAPI Specification v3となっています。最新の仕様に基づいて実装や学習を行いたい方は、公式ドキュメントやそれに関連する資料をご参照ください。 こんにちは！ バックエンドエンジニアのりほやんです。 以前、テックブログでAPIモックと仕様書を作成することができるSwaggerについてご紹介しました。 Swaggerそのものについて知りたい場合やSwaggerを実際に導入したい場合は、こちらの記事がとても参考になります。 techblog.zozo.com 本記事では、SwaggerのAPI定義を行うSwagger YAMLの記法についてまとめてみました。 使い初めはとっつきにくいSwaggerですが、この記事がSwaggerを使う方の参考
Data Types
Multiples Use the multipleOf keyword to specify that a number must be the multiple of another number: type: integer multipleOf: 10 The example above matches 10, 20, 30, 0, -10, -20, and so on. multipleOf may be used with floating-point numbers, but in practice this can be unreliable due to the limited precision or floating point math. type: number multipleOf: 2.5 The value of multipleOf must be a
OpenAPIのYAML分割管理と構成案 - Qiita
はじめに READYFORのエンジニアリング部に所属している熊谷です。 この記事はREADYFOR Advent Calendar 2020の8日目の記事です。 概要 スキーマー駆動開発でOpenAPI（旧Swagger）を導入し始めたところなのですが、その中で、OpenAPIの運用管理について色々調査・検討していたので、記事として共有させていただきます。 対象読者 以下の方々を対象としています API開発でOpenAPI導入を検討している方。 既にOpenAPIの導入済みの方。 背景 ( 課題感 ) スキーマー駆動開発でOpenAPI（旧Swagger）を採用している企業は多いかと思いますが、OpenAPI導入において最初に感じた課題感として、陥りそうな状況の一つとして、最初に運用方針を決めないまま、多数のメンバーが一つのopenapi.yamlにスキーマー定義を追加・更新していった場合
なぜその API は使われないのか？ API の活用を拒む3つの壁とその対策 - CData Software Blog
こんにちは！ CData Software Japan リードエンジニアの杉本です。 大変ありがたいことに、最近あるSaaSを提供する会社さんから「リリース前のAPIを触ってみてフィードバックをくれませんか？」と依頼を受けました。 私は以前こんな記事 を公開するほど、APIどっぷりな人間なのですが、数多くの SaaS APIを触ってきてよく考えることがあります。 それは SaaS APIというサービス・プロダクトそのものを成長させる上で、もっとも重要なことは「顧客・デベロッパーが、そのAPIをどれだけスムーズにキャッチアップできるか？」という点に尽きるのではないか？ というものです。 以下のグラフはAPI管理ツールを提供するSmartBearのAPI調査において、APIドキュメントで最も重要な要素とは何か？ というアンケート結果のランキングですが、ExamplesやAuthenticati
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
MicroProfile OpenAPI Specification
microprofile-open-api/spec/src/main/asciidoc/microprofile-openapi-spec.asciidoc at main · eclipse/microprofile-open-api
microprofile-open-api/tck/src/main/java/org/eclipse/microprofile/openapi/apps/petstore/resource/PetResource.java at main · eclipse/microprofile-open-api
Home
microprofile-open-api/tck/src/main/java/org/eclipse/microprofile/openapi/apps/airlines/JAXRSApp.java at main · eclipse/microprofile-open-api
Swagger UI