AWS開発者のためのAPI開発とは
AWS開発者のためのAPI開発とは、Amazon Web Services (AWS)ビジネスオンラインのプラットフォーム上で動作するサービスを開発するためのプロセスを指しています。AWS開発者のためのAPI開発プロセスでは、RESTfulなAPIを開発して、アプリケーションとサービスを拡張したり、テストしたり、そしていろいろな人々にサービスを提供したりすることができるようになります。
AWS開発者のためのRESTful APIの開発
AWS開発者のためのRESTful APIの開発では、一般的にRESTfulエンドポイントを作り出して、JSONとXMLによるデータストリームを拡張することをゴールとしています。リソースを識別し、RESTfulな処理流を活用して、データを取得・保存できるようなエンドポイントを構築します。例えば以下のようなコードでRESTfulなAPIエンドポイントを作成することが可能です。
// アプリケーションへのURL 接続
app.get('/api/endpoint/users/:id', function (req, res) {
// リクエストデータの取得
let id = req.params.id;
// リクエストデータの取得
let data = userDatabase[id];
// データをレスポンスとして返却
res.json(data);
});
AWS開発者のためのAPIテスト
開発したAPIをテストする際は、サーバーレスのテストツールを使用するのが一般的です。AWS開発者のための専用のテストツールであるAWS Lambdaなどを使用することで、APIをテストすることができます。AWS Lambdaの使用には下記のようなコードを使用します。
// テスト関数を定義する
function testFunction(callback) {
// テスト用の変数を用意する
let testData = {
testMessage: "Test Message Success!"
};
// 任意のテスト実行
// 以下は失敗例
if(testData.testMessage === "Test Message Failed!") {
new Error("Test Message Failed!")
}
// 以下は成功例
if(testData.testMessage === "Test Message Success!") {
// APIレスポンスの取得
callback(null, {
statusCode: 200,
body: JSON.stringify(testData))
});
}
};
AWS開発者のためのAPI公開
開発したAPIを考えるなら、それを外部から安全にアクセスできるような仕組みを提供できることも重要です。AWS開発者のためのAPI公開には、AWS API Gatewayを使用するのが一般的です。API Gateway Serviceでは、HTTP、AWS Lambda、HTTP Proxyなどを使用して、安全に外部からAPIにアクセス可能な環境を作成することができます。AWS API Gatewayを使うサンプルコードは以下のようになります。
// REST APIのエンドポイント
const endpoint = "https://your-application-domain-name.com/api/endpoint";
// API GatewayのGETリクエストを作成
const apiGatewayGet = new AWS.APIGateway.GetResource({
restApiId: 'your-rest-api-id',
resourceId: '/resourceid/api/endpoint',
path: '/api/endpoint',
httpMethod: 'GET',
endpointConfiguration: {
types: [
{
endpointUrl: endpoint,
statusCode: '200'
}
]
}
});
API Gatewayを使うことで、安全に外部からのアクセスを容易に行うことができます。