Documentation for Securing Microcks Mock Endpoints with API Gateways

オープン
#51 コメント 1 件 リアクション 1 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
45/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
活発
技術スタック
aws, nginx

調査の方向性

まず issues 1471 と 1182 の Microcks セキュリティに関する議論を確認し、続いて Kong、AWS API Gateway、Traefik、Apigee、NGINX を中心に依頼されたガイドを構成します。完了条件は、一覧にある実装について、認証、ゲートウェイのセキュリティ制御、rate limiting、アクセス制御を網羅した包括的なコミュニティガイドが完成していることです。

索引モデルが issue の本文から書いたものです。

説明

documentation good first issue help wanted
Describe the bug
Problem:

Currently Microcks provides powerful API mocking capabilities, but there's limited comprehensive documentation on how to properly secure these mock endpoints using authentication mechanisms. The recommended approach is to front Microcks with an API gateway, hence we need clear guidance for implementations across popular gateway solutions.

It would be beneficial if users had step-by-step instructions on how to:

  1. Configure authentication for Microcks mock endpoints
  2. Implement proper security controls via API gateways
  3. Set up best practices for rate limiting and access control
Proposed Solution

Create a comprehensive community-driven guide for securing Microcks endpoints with various API gateway solutions. This would enable users to follow standardized security practices regardless of their gateway of choice.

Tasks
  • Task 1: Define the Current Security Challenges

  • Task 2: Kong Gateway Implementation

  • Task 3: AWS API Gateway Implementation

  • Task 4: Traefik Implementation

  • Task 5: Apigee Implementation

  • Task 6: NGINX Implementation

Call for Contributions

We're looking for community members with expertise in specific API gateways to contribute to this documentation effort. If you have experience with any of the gateways mentioned above or others not listed, please share your knowledge by commenting on this issue or submitting a pull request.

Attach any resources that can help us understand the issue.

These issues in the microcks repo discuss problems related to this issue.
https://github.com/microcks/microcks/issues/1471 (closed)
https://github.com/microcks/microcks/issues/1182 (stale)

主要言語
言語のデータがありません
スター
11
フォーク
9
平均マージ
18分
マージ済み PR(30日)
1

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

microcks/community のほかの issue

microcks/community の issue をすべて見る

似ている issue

Backend & API Design の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。