操作ガイド 3 min read RAMLとは?その書き方を解説 RAML(Restful API Modeling Language) は、RESTful APIを定義するためのYAMLベースのマークアップ言語です。Restful APIがどんどん主流になっている今、RAMLをマスターする必要があるのでしょう。本文では、RAMLを詳しく紹介した上、RAMLの書き方も一緒に皆さんに解説していきたいと思います。
操作ガイド 4 min read OpenAPI(Swagger)仕様書をHTMLに出力 OpenAPI仕様書をHTMLに出力すると、API仕様を簡単に確認することもできますし、他人に共有することも簡単になります。本文では、非常に使いやすいAPI管理ツールを使って、OpenAPIの仕様書をHTMLに簡単に出力する操作手順を皆さんに紹介します。
操作ガイド 4 min read JSONとYAMLの違い:APIをJSONからyamlに変換 JSONとyamlもAPIの記述によく利用されている形式です。時には、何らかの原因によって、APIのJSON記述からyaml記述に変換する必要があります。本文では、APIをJSONからyamlに変換する簡単な方法を皆さんに紹介します。
操作ガイド 3 min read 解説:yamlでAPI仕様書・設計書の作り方 APIの使い方や動作条件などの情報を正確に伝えるために、API仕様書を作成する必要があります。yamlはOpenAPIとSwaggerのデフォルト記述形式として、API設計書・仕様書を作成する時によく利用されています。本文では、yaml形式でAPI仕様書・設計書を作る方法を詳しく解説します。
操作ガイド 4 min read YAMLとは、その書き方をわかりやすく解説 Webアプリケーションを作成する際には、YMALがよく利用されているので、Webアプリ開発には必須なスキルだとも言えます。そこで、YAMLを詳しく理解すれば、アプリの開発効率の向上にもつながると思います。本文では、YAMLとは何かを完全に解説した上、YAMLファイルの書き方をも皆さんにわかりやすく解説していきたいと思います。
操作ガイド 2 min read APIのバージョン管理:最簡単な実現方法をご紹介 APIの機能や仕様をアップデートしていくにあたって、変更履歴をバージョン番号で管理する必要があります。本文では、APIのバージョン管理を実現できる最簡単な実現方法を皆さんに紹介します。
操作ガイド 4 min read apiDocとは、その使い方を解説する! APIをよく取り扱っている場合は、Apidocというものをよく耳にしていますね。それでは、Apidocとは何ですか?何かを実現できますか?本文では、これらの質問に対して、Apidoc及びその使い方を完全に解説していきます。
ソリューション 3 min read 完全解説:1分間で分かるPUTとPOSTの違い PUTとPOSTとも、HTTPプロトコルで使用されるリクエストのメソッドになります。それでは、PUTとPOSTとの違いはなんですか?本文では、PUTとPOSTといったHTTPメソッドを詳しく紹介した上、どのよう場合はPUTを使うのか、どのような場合はPOSTを使うのかということも詳しく紹介していきます。
ソリューション 3 min read 解説:APIレスポンスでエラーメッセージをどうする? APIのエラーメッセージとは、APIを利用しているときに発生するエラーの内容を示すメッセージのことです。本文では、APIのエラーメッセージを詳しく解説した上、エラーメッセージを設定できる簡単な方法をも一緒に紹介します。
ソリューション 3 min read OpenAPI仕様とは、使いやすい記述ツールをご紹介! 現在アプリケーションの開発中に、APIを導入して機能を拡張したりすることが非常に普通なことになっています。そんな中、OpenAPIはAPI仕様のフォーマットとして開発者によく知られています。本文では、OpenAPIについて詳しく紹介する上、OpenAPI仕様を記述するツールを皆さんに紹介します。
操作ガイド 3 min read 「サンプル付き」APIレスポンスでJSONデータを使用する APIを設計するときに、そのレスポンスでは、JSONデータを使うのは一番多くなります。本文では、さまざまな基本知識を解説した上、どのようにAPIレスポンスでJSONデータを使用するのかを皆さんに紹介します。
観点 5 min read ナレッジベース:SwaggerとOpenAPIの違いとは? SwaggerとOpenAPiともRESTful APIの仕様を定義するツールの集合になります。本文では、SwaggerとOpenAPIの違いについて皆さんに紹介します。