2022幎2月03日·1分で読めたす

コヌドなしでAPIを䜜成する方法

ノヌコヌドコンストラクタヌずプラットフォヌムを䜿甚するず、APIを簡単に䜜成でき、埓来の開発よりも䜕倍も高速に実行できたす。

コヌドなしでAPIを䜜成する方法

この蚘事では、プロレベルのノヌコヌドプラットフォヌムであるAppMaster.ioでAPIを操䜜する方法を説明したす。ただし、最初に、APIに関するいく぀かの基本的な情報を思い出しおみたしょう。

序章

APIは、アプリケヌションプログラミングむンタヌフェむスを意味したす。これらは、クラむアントずサヌバヌが盞互に通信する方法です。クラむアントずサヌバヌはリク゚ストずレスポンスを送信し、APIはそれらの間の仲介圹ずしお機胜したす。

このクラむアント/サヌバヌの盞互䜜甚は、単玔で、理解しやすく、䟿利でなければなりたせん。これにより、開発者のタスク新しいサヌビスを再発明する必芁がないずナヌザヌサヌビスが䜿い慣れおいるず習埗しやすくなりたすの䞡方が簡玠化されたす。 APIにはいく぀かの皮類がありたす。

  • WebサヌビスAPI、XML-RPC、およびJSON-RPC、SOAP。
  • WebSocket API;
  • ラむブラリベヌスのAPI、Javaスクリプト。
  • クラスベヌスのAPI、CAPI、Java。

ノヌコヌドAppMaster.ioプラットフォヌムでは、RESTAPIスタむルを䜿甚したす。

RESTたたはRepresentationalState Transfer党䜓は、クラむアントずサヌバヌ間の盞互䜜甚情報亀換のアヌキテクチャヌスタむルです。 REST APIのサヌビスは、HTTPプロトコルを䜿甚しお通信したす。

スタむルRESTには特定の利点がありたす。 RESTの䞻な利点は、優れた柔軟性です。 RESTは単玔なガむドラむンで構成されおおり、開発者は芁件を自分の圢匏で実装できたす。 RESTは高性胜であり、これは、たずえばモバむルデバむスでの高速ロヌドにずっお非垞に重芁です。そのため、TwitterやGoogleなどのすべおの倧䌁業は、自瀟補品にRESTAPIを長い間実装しおきたした。 REST APIの䜜業ず䞻な利点に぀いお詳しくは、蚘事をご芧ください。

リク゚ストの構造には、HTTPメ゜ッド、゚ンドポむント、ヘッダヌず本文、リク゚ストパラメヌタの5぀の䞻芁コンポヌネントが含たれたす。

REST APIは、4぀の基本HTTPメ゜ッドを䜿甚しおリ゜ヌス情報を凊理したす。各メ゜ッドは、リ゜ヌスで䜕を実行する必芁があるかを蚘述したす。

  • POST —リ゜ヌスの䜜成。
  • GET —リ゜ヌスを取埗したす。
  • PUT —リ゜ヌスの曎新。
  • DELETE —リ゜ヌスを削陀したす。

リ゜ヌスずは、任意の情報ドキュメント、画像、ビデオ、テキストなどです。 AppMaster.ioノヌコヌドプラットフォヌムでは、この情報は、最も䞀般的な圢匏であるJSONを含むいく぀かの圢匏でクラむアントに配信されたす。

゚ンドポむントには、URIUniform Resource IdentifierUniform Resource Identifierが含たれおいたす。これは、むンタヌネット䞊のリ゜ヌスを芋぀ける堎所ず方法を瀺し、URLを含みたすURLたたはUniform Resource Locationは完党なWebアドレスです。

ヘッダヌは、クラむアントずサヌバヌの䞡方に情報を䌝達したす。ヘッダヌは䞻に認蚌デヌタAPIキヌ、サヌバヌがむンストヌルされおいるコンピュヌタヌの名前たたはIPアドレス、および応答圢匏を提䟛したす。

本䜓は、サヌバヌに远加情報を枡すために必芁です。本䜓デヌタは、たずえば、远加たたは眮換するデヌタです。

プラットフォヌム䞊のアプリケヌションのAPIドキュメントは自動的に生成され、OpenAPISwagger圢匏でバック゚ンドに保存されたす。

AppMaster.ioでAPIを構築する方法を孊ぶために、それがどのように機胜するかを正確に理解する必芁はありたせん。プラットフォヌムのツヌルに぀いお孊ぶこずで、基本的な原則を理解できたす。さらに、APIの䞭心郚分はAppMaster.ioによっお䜜成されたす。ほずんどの蚭定は、デフォルトで、たたはモゞュヌルを接続するずきに行われたす。 ‌たずえば、このモゞュヌルは、メヌルのAPIず統合するためのツヌルを提䟛したす。

アプリケヌションを他のアプリケヌションたたは倖郚リ゜ヌスに統合接続する堎合は、䞀郚のAPI蚭定に手動で小さな倉曎を加える必芁がありたす。次に、これを行う方法を芋おいきたす。

ノヌコヌドプラットフォヌムAppMaster.ioを䜿甚したAPIの䜜成

そのため、API蚭定はプラットフォヌムのいく぀かの堎所にありたす。

ノヌコヌドプラットフォヌムAppMaster.ioでAPI゚ンドポむントを䜜成する方法

既存のプロゞェクトのアカりントにログむンしたす。

デヌタモデルデザむナに移動したす。デヌタモデルデザむナには、゚ンドポむントAPIを䜿甚しお凊理するデヌタを含むモデルが衚瀺されたす。各プロゞェクトでは、開始時に、デフォルトで垞に1぀のモデルであるナヌザヌが存圚したす。新しいプロゞェクトに参加しおいお、モデルがただない堎合は、モデルを䜜成したす。

モデル間にリンクを割り圓お、プロゞェクトを保存したす。

画面の巊偎のメニュヌの[゚ンドポむント]セクションに移動したす。

ここに、プロゞェクトフィヌルドの各モデルに接続されおいるすべおの゚ンドポむントずそれらで䜿甚可胜なRESTAPIメ゜ッドのリストが衚瀺されたす。䞍芁なメ゜ッドを削陀しお蚭定を倉曎したす歯車アむコンずごみ箱アむコン。

リストに適切な゚ンドポむントがない堎合は、[新しい゚ンドポむント]ボタンをクリックしお適切なタむプを遞択するこずにより、新しい゚ンドポむントを䜜成できたす。゚ンドポむント蚭定のあるモヌダルりィンドりが開きたす。

ノヌコヌドプラットフォヌムAppMaster.ioで倖郚APIを䜜成する方法

巊偎のメニュヌの[ビゞネスロゞック]セクションに移動したす。

ここで、[倖郚APIリク゚スト]タブで倖郚APIリク゚ストを䜜成できたすこのオプションはベヌタ版です。

さらに、前述のように、すべおのドキュメントは自動的に生成され、アプリケヌションのバック゚ンドにOpenAPISwagger圢匏で保存されたす。

Swaggerはドキュメントであり、Postmanなどのサヌドパヌティアプリケヌションを䜿甚せずにすべおの゚ンドポむントをその堎でテストする機胜です。

結論

最初のAPIを䜜ろう
デヌタモデルからREST゚ンドポむントを䜜成し、OpenAPIドキュメントが自動生成されたす。
䜜り始める

ご芧のずおり、ノヌコヌドを䜿甚したAPI蚭定の䜜成ず倉曎は非垞に簡単で、最小限の時間で枈みたす。 AppMaster.ioのアカりントをただお持ちでない堎合は、ぜひご参加いただき 、詊甚版にサむンアップしお ください。

始めやすい
䜕かを䜜成する 玠晎らしい

無料プランで AppMaster を詊しおみおください。
準備が敎ったら、適切なサブスクリプションを遞択できたす。

始める
コヌドなしでAPIを䜜成する方法 | AppMaster