New APIs for Promgen #578
Open
New APIs for Promgen #578
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hoangpn
force-pushed
the
feature/new_apis
branch
10 times, most recently
from
6e95e31 to
aef3f79
Compare
hoangpn
force-pushed
the
feature/new_apis
branch
4 times, most recently
from
99d5e1a to
e8fa273
Compare
hoangpn
force-pushed
the
feature/new_apis
branch
3 times, most recently
from
c58a8c5 to
7981f71
Compare
hoangpn
force-pushed
the
feature/new_apis
branch
4 times, most recently
from
73415b2 to
05bc663
Compare
When accessing APIs created by Promgen's Django REST Framework, users will need a Token for authentication. We have added a new panel on the Profile page that allows users to create and manage their own tokens.
We plan to add version v2 to Promgen's API. We have chosen drf-spectacular as the OpenAPI 3 Schema Generation for these new APIs. We also use Rapidoc for the OpenAPI Spec Documentation.
Users must be authenticated before making any REST calls to Promgen's APIs. We changed the default permission class of Django REST Framework from DjangoModelPermissionsOrAnonReadOnly to DjangoModelPermissions.
- Add v2 Router for v2 APIs. - Create rest_v2.py file with base functions: RuleMixin, NotifierMixin and PromgenPagination.
We have added several APIs for retrieving User data. - List User - Get the User data based on the current Token
We have added several APIs for retrieving and filtering Audit Log data.
We have added several APIs for retrieving and updating Notifier, as well as Notifier's filters.
We have added several APIs for retrieving, updating and deleting Rule.
We have added several APIs for interacting with Farm, as well as Farm's hosts.
We have added several APIs for retrieving Exporter data.
We have added several APIs for retrieving URL data.
We have added several APIs to help users easily manage Projects and objects related to each project, such as notifiers, rules, exporters, and URLs.
We have added several APIs to help users easily manage Services and objects related to each service, includes notifiers and rules.
We have added several APIs for retrieving Shard data and the list of projects for each shard.
Add a custom exception handler to wrap all exceptions that are not handled by the REST framework's default exception handler into a JSON response with a 500 Internal Server Error HTTP status code.
We add two limits to the number of requests from authenticated users and non-authenticated users to prevent the APIs from being overloaded.
We have added middleware logging for request/response to API calls via v2 APIs. The logging information includes the IP address, user (if authenticated), request details, and response details. Enabling or disabling this logging can be configured through setting.ENABLE_API_LOGGING.
hoangpn
force-pushed
the
feature/new_apis
branch
from
05bc663 to
5f16929
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add APIs that now allow users to fully interact with Promgen via the API. This includes:
The new APIs have the prefix
/rest/v2. The API Specification for these new APIs can be accessed through the menu Misc -> API v2.This specification flow the Open API Standard, therefore users can download YAML file and import it to many tools such as Swagger Editor or Postman.
Non-GET APIs require authentication. Each user's token can be obtained by accessing the Profile page.
These APIs have separate rate limit thresholds set for IP addresses (for unauthenticated users) and user_id (for authenticated users).
https://github.com/line/promgen/pull/578/files#diff-f81908c759379ab44e3e0e2ffbc41d8c559e648d7c30df301d6cc6bcaac85208R206-R213
Detailed data about the request/response of the APIs can also be logged when
setting.ENABLE_API_LOGGING=Trueis configured.https://github.com/line/promgen/pull/578/files#diff-f81908c759379ab44e3e0e2ffbc41d8c559e648d7c30df301d6cc6bcaac85208R247