操作ガイド 3 min read HTTP APIとは?それをテストする方法を紹介 APIの中でHTTP APIが一番汎用されている種類になります。現在主流となっているREST APIもHTTP APIに属しています。それでは、HTTP APIとは何ですか?何か特徴がありますか?本文では、これらの問題を解明していきたいと思います。
操作ガイド 5 min read 完全ガイド:Swagger UIをローカルで利用する Swagger UIはSwagger Specification(OpenAPI Specification)で記述されたAPIドキュメントを視覚的に確認できるツールです。Swagger UIはオフラインとオンラインのバージョンをも提供してくれていますが、色々な原因でSwagger UIをローカルで利用する必要があります。本文では、Swagger UIをローカルで利用する方法を皆さんに紹介します。
操作ガイド 4 min read 詳細ガイド:Swagger APIドキュメントを作成する方法 Swagger(OpenAPI)は、APIの標準仕様として、一番多くの場合は、Swagger APIドキュメントを作成する必要があるのでしょう。本文では、SwaggerのAPIドキュメントを作成する方法を詳しく皆さんに紹介します。
操作ガイド 5 min read 解説:Swagger(OpenAPI)の 仕様書の書き方 SwaggerやOpenAPIは、API業界標準の仕様になります。API設計を標準化にしたりする必要がある場合、SwaggerやOpenAPI仕様書の書き方をマスタする必要があるのでしょう。本文では、SwaggerとOpenAPIの仕様書の書き方を皆さんに詳しく解説するので、必要な方は本文の内容を参照してください。
観点 2 min read YAMLとRAMLの違い|YAMLとRAML互換ツールおすすめ APIを定義する時に、YAMLとRAMLなど、ややこしい用語がたくさんあります。この2つの用語は、非常に類似したものですが、大きな違いがあります。本文では、YAMLとRAMLとの違いを解説した上、RAMLをより汎用されているYAMLに変換する方法を皆さんに紹介しようと思います。
操作ガイド 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仕様書・設計書を作る方法を詳しく解説します。
操作ガイド 3 min read YAMLとは、その書き方をわかりやすく解説 Webアプリケーションを作成する際には、YMALがよく利用されているので、Webアプリ開発には必須なスキルだとも言えます。そこで、YAMLを詳しく理解すれば、アプリの開発効率の向上にもつながると思います。本文では、YAMLとは何かを完全に解説した上、YAMLファイルの書き方をも皆さんにわかりやすく解説していきたいと思います。
操作ガイド 2 min read APIのバージョン管理:最簡単な実現方法をご紹介 APIの機能や仕様をアップデートしていくにあたって、変更履歴をバージョン番号で管理する必要があります。本文では、APIのバージョン管理を実現できる最簡単な実現方法を皆さんに紹介します。
操作ガイド 3 min read Apidocとは、その使い方を解説する! APIをよく取り扱っている場合は、Apidocというものをよく耳にしていますね。それでは、Apidocとは何ですか?何かを実現できますか?本文では、これらの質問に対して、Apidoc及びその使い方を完全に解説していきます。