APIの開発は複雑でコストがかかる可能性があり、頻繁に更新されることからドキュメントを整備するのも難しい。APIの設計、開発、ドキュメントの整備、管理にまつわる課題と効率さの問題に対処するアプローチが、RESTful API Modeling Language（RAML：RESTful APIモデリング言語）だ。 RAMLコードを使えば、開発者はAPIの動作を説明する仕様を策定してからそのAPIをデプロイするまでのAPIライフサイクルを管理することができる。 RAMLとは RAMLは、RESTful APIを記述することを目的とするオープンソースの記述言語だ。2013年、米国のIT自動化および統合ベンダーであるMuleSoftを中心とする数社の企業によって作成されたRAMLはAPIの開発に大きな役割を果たしてきた。2018年、MuleSoftはSalesforceによって買収され、RAML
尺貨マン on Twitter: "編成写真の難しさを図解。以前のツイートに皆様のご意見を加えた改訂版となります。 https://t.co/w91RAmL7ix"
編成写真の難しさを図解。以前のツイートに皆様のご意見を加えた改訂版となります。 https://t.co/w91RAmL7ix
OpenAPI関連のサイト・ツールまとめ2020.10.29 OpenAPI関連のサイトやツールなどの情報が種々雑多にあるので、自分の中での整理と忘備録として残すためにまとめました。（2020年10月時点） 概要OpenAPIとはOpenAPIという表現が使われた場合、恐らくそれらの多くはOpenAPI Specification（以下OAS）に基づいてJSONやYAMLで記述されたREST APIの仕様書（スキーマ）を指しているように思います。 OASはREST APIの仕様を記述するための規格であり、それ自体がなにかのツールやサービスを提供するものではありません。 とはいえ関連するツールやサービスも普及してきているので、あまり言葉の意味を気にしすぎる必要もないかもしれませんが。 OpenAPI Specification (v3.0.3)Implementer’s Draft (OAS
こんにちは。CTOの河内です。 多くのプロジェクトがスタート時はそうである通り、我々のプロジェクトもAPI仕様がありませんでした。 最初は規模が小さく問題として認識されていなかったのですが、規模が大きくなり、また開発者の入れ替わりを経験するごとに、「この API って何返してくるの？」という問いに答えられる人が段々といなくなってきました。 「ソースが仕様だ」とサーバの実装を読めばもちろん答えられるのですが、ソースコードを読み解く時間がかかるため効率的ではありません。 また、サーバ実装が唯一の情報源となるため、ロジックが何かおかしいと感じても、それが仕様なのかバグなのか判断できない状態でした。 API仕様を先に定義し、通信上の疑問にはAPI仕様で答えられるようにしたかったのです。 これは一般的な課題で、日本CTO協会が2019年12月に公開した DX Criteria DX Criteria
RGAでインフラエンジニアをしている川合です。 以前SHIFT EVOLVEでOpenAPIについて発表したのですが、この時はライトニングトークだったということで持ち時間も少なく、あまり詳しくは話すことができなかったので、以下の2点についてここで少し詳しく書いておこうと思います。 OpenAPIというものはなにかの概要解説 OpenAPIを用いた開発手法について簡単な説明 ※元のスライドはこちらをご参照ください。 https://speakerdeck.com/shift_evolve/apihuasutofalsekai-fa ※コードはこちらにありますので合わせご参照ください。 https://github.com/kwryoh/oapi-sample OpenAPI とはOpenAPIはRESTful API記述方法のひとつです。 APIの各パスやリクエスト・レスポンスの形式の仕様を
Overview
Welcome! 👋 Taxi is a language for documenting data - such as data models - and the contracts of APIs. Specifically, Taxi aims to describe how data & APIs across an ecosystem relate with one another, and to allow consumers to compose services together, without being coupled to underlying APIs. Taxi describes data semantically - using rich semantic types - ie., types that, which allows powerful too
Postmanとは Postmanの使い方を解説する前に、そもそもPostmanについて軽く概要を説明します。 Postmanとは、APIを開発・テストするときには欠かせないツールです。 Postmanには API client（APIクライアント）：HTTPリクエストを設定して、テストを簡単に行うことができる API design（API設計）：OpenAPI、RAML、GraphQL、またはSOAPフォーマットを使用してAPI仕様を設計できる API documentation（APIドキュメント）：自動でAPIのドキュメントを生成できる API testing（APIテスト）：APIのテストを自動化して実行できる Mock servers（モックサーバー）：APIのリクエストを送れない場合に使う。APIエンドポイントをシミュレートができる Monitors（モニター）：APIのパフォ
[GitHub] Markdownの「シンタックスハイライト」に対応している言語一覧 - ねこの足跡R
Markdownでプログラムのソースコードを記述する場合に使うバッククォート3つで囲う「コードブロック」ですが、気の利いた環境だと自動的にシンタックスハイライトによって予約語やコメント分などを色分けして見やすく表示してくれます。 GitHubも例外ではなく、各リポジトリに常設されているWikiやREADMEなどをMarkdownで記述した場合は自動的にシンタックスハイライトされます。 メジャーな言語であればそのまま記述すればよいのですが、例えばYAMLやJSONなどのデータ形式や、Apacheの設定ファイルなどそもそもカラーシンタックスに対応しているのか、対応している場合キーワードはなんだろうと迷いますよね。 今回はGitHubが対応しているカラーシンタックスの設定一覧をまとめておきます。 ハイライトのやり方 GitHubで利用できる言語一覧 定義 一覧 おまけ 抽出方法 参考ページ ハイ
![[GitHub] Markdownの「シンタックスハイライト」に対応している言語一覧 - ねこの足跡R](https://cdn-ak-scissors.b.st-hatena.com/image/square/e5bf125aecc59cdb944df8797e85524099779984/height=288;version=1;width=512/https%3A%2F%2Fogimage.blog.st-hatena.com%2F820878482973262145%2F6801883189061409297%2F1701758116)
Welcome to a new series of posts that will take you on a visual journey through the OpenAPI Specification (OAS) and its tooling ecosystem! Why diagram the OAS ecosystem? As part of the efforts to design OAS 3.2 and 4.0 “Moonwalk”, I wanted to figure out how different sorts of tools work with the OAS. Moonwalk is an opportunity to re-think everything, and I want that re-thinking to make it easier t
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
RESTful APIの設計、開発、ドキュメント管理を手助けする「RAML」とは
OpenAPI関連のサイト・ツールまとめ | GiFT（ギフト）株式会社
独自の外部 DSL 編集をエディタでサポートする - FLINTERS Engineer's Blog
OpenAPI（APIドキュメント）を用いたGoのAPIサーバー開発｜SHIFT Group 技術ブログ
【Postman】基本的な使い方を解説します
Analyzing the OpenAPI Tooling Ecosystem