-
Notifications
You must be signed in to change notification settings - Fork 5k
[DSIP-7] [API] Suggest refactor the backend api #10257
Copy link
Copy link
Closed
Labels
DSIPbackendfeaturenew featurenew featurehelp wantedExtra attention is neededExtra attention is needed
Milestone
Description
Search before asking
- I had searched in the issues and found no similar feature requirement.
Description
Purpose:
A user-friendly and high-performance restful API is our goal.
Refactor reason:
- Use restful style to unify API specifications
- Solve the current incomplete API document and reduce the threshold of API use
- Improve API reusability
- Reduce unnecessary data return and improve performance
- Improve the readability of the code and reduce the maintenance cost
- Improve the accuracy of error reporting
API output Standard:
Content-Typeusingapplication/json(segmented upload file is not applicable)- Users can simply understand how to call the API normally by reading the API docs
- The input and output parameters of API should avoid using types that cannot be intuitively understood, such as
JSONandMAP - All enumeration values in the API need to be included in the API document
- Comply with restful specifications
- The error information requested by API can accurately express the cause of the error
- Rename all
processtoworkflowas we discussed in [DSIP-7] [API] Suggest refactor the backend api #10257 (comment) - The service refactoring part and the controller refactoring part should be divided into two PR base on the conclusions in [Feature-10983] [refactor] ResourcesController #10998 (comment)
Please reply the controller name and its function name you want to participate in and the issue you created. I will link it to this issue and assign it to you. Anyone who wants to participate is very welcome ^_^
Current API
Login page
| Controller | Function | issue | status |
|---|---|---|---|
| LoginController | login | #10459 | |
| LoginController | signOut | #10459 |
Project manage page
Project
| Controller | Function | issue | status |
|---|---|---|---|
| ProjectController | createProject | #10489 | ✅ |
| ProjectController | updateProject | #10489 | ✅ |
| ProjectController | queryProjectByCode | #10489 | ✅ |
| ProjectController | queryProjectListPaging | #10489 | ✅ |
| ProjectController | deleteProject | #10489 | ✅ |
| ProjectController | queryUnauthorizedProject | #10489 | ✅ |
| ProjectController | queryAuthorizedProject | #10489 | ✅ |
| ProjectController | queryAuthorizedUser | #10489 | ✅ |
| ProjectController | queryProjectCreatedAndAuthorizedByUser | #10489 | ✅ |
| ProjectController | queryAllProjectList | #10489 | ✅ |
Workflow Monitor
| Controller | Function | issue | status |
|---|---|---|---|
| DataAnalysisController | countTaskState | #12969 | |
| DataAnalysisController | countProcessInstanceState | #12969 | |
| DataAnalysisController | countDefinitionByUser | #12969 | |
| DataAnalysisController | countCommandState | #12969 | |
| DataAnalysisController | countQueueState | #12969 |
Workflow Relationship
| Controller | Function | issue | status |
|---|---|---|---|
| WorkFlowLineageController | queryWorkFlowLineageByName | ||
| WorkFlowLineageController | queryWorkFlowLineageByCode | ||
| WorkFlowLineageController | queryWorkFlowLineage | ||
| WorkFlowLineageController | verifyTaskCanDelete |
Workflow Definition
| Controller | Function | issue | status |
|---|---|---|---|
| ProcessDefinitionController | createProcessDefinition | #11129 | |
| ProcessDefinitionController | copyProcessDefinition | #11129 | |
| ProcessDefinitionController | moveProcessDefinition | #11129 | |
| ProcessDefinitionController | verifyProcessDefinitionName | #11129 | |
| ProcessDefinitionController | updateProcessDefinition | #11129 | |
| ProcessDefinitionController | queryProcessDefinitionVersions | #11129 | |
| ProcessDefinitionController | switchProcessDefinitionVersion | #11129 | |
| ProcessDefinitionController | deleteProcessDefinitionVersion | #11129 | |
| ProcessDefinitionController | releaseProcessDefinition | #11129 | |
| ProcessDefinitionController | queryProcessDefinitionByCode | #11129 | |
| ProcessDefinitionController | queryProcessDefinitionByName | #11129 | |
| ProcessDefinitionController | queryProcessDefinitionList | #11129 | |
| ProcessDefinitionController | queryProcessDefinitionSimpleList | #11129 | |
| ProcessDefinitionController | queryProcessDefinitionListPaging | #11129 | |
| ProcessDefinitionController | viewTree | #11129 | |
| ProcessDefinitionController | getNodeListByDefinitionCode | #11129 | |
| ProcessDefinitionController | getNodeListMapByDefinitionCodes | #11129 | |
| ProcessDefinitionController | getProcessListByProjectCodes | #11129 | |
| ProcessDefinitionController | getTaskListByProcessDefinitionCode | #11129 | |
| ProcessDefinitionController | deleteProcessDefinitionByCode | #11129 | |
| ProcessDefinitionController | batchDeleteProcessDefinitionByCodes | #11129 | |
| ProcessDefinitionController | batchExportProcessDefinitionByCodes | #11129 | |
| ProcessDefinitionController | queryAllProcessDefinitionByProjectCode | #11129 | |
| ProcessDefinitionController | importProcessDefinition | #11129 | |
| ProcessDefinitionController | createEmptyProcessDefinition | #11129 | |
| ProcessDefinitionController | updateProcessDefinitionBasicInfo | #11129 | |
| ProcessDefinitionController | releaseWorkflowAndSchedule | #11129 |
Workflow Instance
| Controller | Function | issue | status |
|---|---|---|---|
| ProcessInstanceController | queryProcessInstanceList | #10263 | |
| ProcessInstanceController | queryTaskListByProcessId | #10263 | |
| ProcessInstanceController | updateProcessInstance | #10263 | |
| ProcessInstanceController | queryProcessInstanceById | #10263 | |
| ProcessInstanceController | queryTopNLongestRunningProcessInstance | #10263 | |
| ProcessInstanceController | deleteProcessInstanceById | #10263 | |
| ProcessInstanceController | querySubProcessInstanceByTaskId | #10263 | |
| ProcessInstanceController | queryParentInstanceBySubId | #10263 | |
| ProcessInstanceController | viewVariables | #10263 | |
| ProcessInstanceController | viewTree | #10263 | |
| ProcessInstanceController | batchDeleteProcessInstanceByIds | #10263 |
Task Definition
| Controller | Function | issue | status |
|---|---|---|---|
| TaskDefinitionController | createTaskDefinition | ||
| TaskDefinitionController | createTaskBindsWorkFlow | ||
| TaskDefinitionController | updateTaskDefinition | ||
| TaskDefinitionController | updateTaskWithUpstream | ||
| TaskDefinitionController | queryTaskDefinitionVersions | ||
| TaskDefinitionController | switchTaskDefinitionVersion | ||
| TaskDefinitionController | deleteTaskDefinitionVersion | ||
| TaskDefinitionController | deleteTaskDefinitionByCode | ||
| TaskDefinitionController | queryTaskDefinitionDetail | ||
| TaskDefinitionController | queryTaskDefinitionListPaging | ||
| TaskDefinitionController | genTaskCodeList | ||
| TaskDefinitionController | releaseTaskDefinition |
Task Instance
| Controller | Function | issue | status |
|---|---|---|---|
| TaskInstanceController | queryTaskListPaging | #11713 | ✅ |
| TaskInstanceController | forceTaskSuccess | #11713 | ✅ |
Task Group
| Controller | Function | issue | status |
|---|---|---|---|
| TaskGroupController | createTaskGroup | ||
| TaskGroupController | updateTaskGroup | ||
| TaskGroupController | queryAllTaskGroup | ||
| TaskGroupController | queryTaskGroupByStatus | ||
| TaskGroupController | queryTaskGroupByCode | ||
| TaskGroupController | closeTaskGroup | ||
| TaskGroupController | startTaskGroup | ||
| TaskGroupController | forceStart | ||
| TaskGroupController | modifyPriority | ||
| TaskGroupController | queryTasksByGroupId |
Mornitor center
| Controller | Function | issue | status |
|---|---|---|---|
| MonitorController | listMaster | #10458 | |
| MonitorController | listWorker | #10458 | |
| MonitorController | queryDatabaseState | #10458 |
Datasource center
| Controller | Function | issue | status |
|---|---|---|---|
| DataSourceController | createDataSource | #10460 | |
| DataSourceController | updateDataSource | #10460 | |
| DataSourceController | queryDataSource | #10460 | |
| DataSourceController | queryDataSourceListPaging | #10460 | |
| DataSourceController | connectDataSource | #10460 | |
| DataSourceController | connectionTest | #10460 | |
| DataSourceController | deleteDataSource | #10460 | |
| DataSourceController | verifyDataSourceName | #10460 | |
| DataSourceController | unauthDatasource | #10460 | |
| DataSourceController | authedDatasource | #10460 | |
| DataSourceController | getKerberosStartupState | #10460 | |
| DataSourceController | getTables | #10460 | |
| DataSourceController | getTableColumns | #10460 |
Resource center
| Controller | Function | issue | status |
|---|---|---|---|
| ResourcesController | createDirectory | #10983 | |
| ResourcesController | createResource | #10983 | |
| ResourcesController | updateResource | #10983 | |
| ResourcesController | queryResourceList | #10983 | |
| ResourcesController | queryResourceListPaging | #10983 | |
| ResourcesController | deleteResource | #10983 | |
| ResourcesController | verifyResourceName | #10983 | |
| ResourcesController | queryResourceJarList | #10983 | |
| ResourcesController | queryResource | #10983 | |
| ResourcesController | viewResource | #10983 | |
| ResourcesController | onlineCreateResource | #10983 | |
| ResourcesController | updateResourceContent | #10983 | |
| ResourcesController | downloadResource | #10983 | |
| ResourcesController | createUdfFunc | #10983 | |
| ResourcesController | viewUIUdfFunction | #10983 | |
| ResourcesController | updateUdfFunc | #10983 | |
| ResourcesController | queryUdfFuncListPaging | #10983 | |
| ResourcesController | queryUdfFuncList | #10983 | |
| ResourcesController | verifyUdfFuncName | #10983 | |
| ResourcesController | deleteUdfFunc | #10983 | |
| ResourcesController | authorizedFile | #10983 | |
| ResourcesController | authorizeResourceTree | #10983 | |
| ResourcesController | unauthUDFFunc | #10983 | |
| ResourcesController | authorizedUDFFunction | #10983 | |
| ResourcesController | queryResourceById | #10983 | |
| TaskGroupController | createTaskGroup | ||
| TaskGroupController | updateTaskGroup | ||
| TaskGroupController | queryAllTaskGroup | ||
| TaskGroupController | queryTaskGroupByStatus | ||
| TaskGroupController | queryTaskGroupByCode | ||
| TaskGroupController | closeTaskGroup | ||
| TaskGroupController | startTaskGroup | ||
| TaskGroupController | forceStart | ||
| TaskGroupController | queryTasksByGroupId |
Dataquality center
| Controller | Function | issue | status |
|---|---|---|---|
| DataQualityController | getRuleFormCreateJsonById | ||
| DataQualityController | queryRuleListPaging | ||
| DataQualityController | queryRuleList | ||
| DataQualityController | queryExecuteResultListPaging | ||
| DataQualityController | getDatasourceOptionsById |
Security center
| Controller | Function | issue | status |
|---|---|---|---|
| AccessTokenController | queryProcessInstanceList | #10290 | ✅ |
| AccessTokenController | generateToken | #10459 | |
| AccessTokenController | queryAccessTokenList | #10459 | |
| AccessTokenController | queryAccessTokenByUser | #10459 | |
| AccessTokenController | delAccessTokenById | #10459 | |
| TenantController | createTenant | #10467 | |
| TenantController | queryTenantlistPaging | #10467 | |
| TenantController | queryTenantlist | #10467 | |
| TenantController | updateTenant | #10467 | |
| TenantController | deleteTenantById | #10467 | |
| TenantController | verifyTenantCode | #10467 | |
| UsersController | createUser | ||
| UsersController | queryUserList | ||
| UsersController | updateUser | ||
| UsersController | delUserById | ||
| UsersController | grantProject | ||
| UsersController | grantProjectByCode | ||
| UsersController | revokeProject | ||
| UsersController | grantResource | ||
| UsersController | grantUDFFunc | ||
| UsersController | grantNamespace | ||
| UsersController | grantDataSource | ||
| UsersController | getUserInfo | ||
| UsersController | listUser | ||
| UsersController | listAll | ||
| UsersController | verifyUserName | ||
| UsersController | unauthorizedUser | ||
| UsersController | authorizedUser | ||
| UsersController | registerUser | ||
| UsersController | activateUser | ||
| UsersController | batchActivateUser | ||
| AlertGroupController | createAlertgroup | ||
| AlertGroupController | list | ||
| AlertGroupController | listPaging | ||
| AlertGroupController | queryAlertGroupById | ||
| AlertGroupController | updateAlertgroup | ||
| AlertGroupController | delAlertgroupById | ||
| AlertGroupController | verifyGroupName | ||
| AlertPluginInstanceController | createAlertPluginInstance | ||
| AlertPluginInstanceController | updateAlertPluginInstance | ||
| AlertPluginInstanceController | deleteAlertPluginInstance | ||
| AlertPluginInstanceController | getAlertPluginInstance | ||
| AlertPluginInstanceController | getAlertPluginInstance | ||
| AlertPluginInstanceController | verifyGroupName | ||
| AlertPluginInstanceController | listPaging | ||
| WorkerGroupController | saveWorkerGroup | #12072 | |
| WorkerGroupController | queryAllWorkerGroupsPaging | #12072 | |
| WorkerGroupController | queryAllWorkerGroups | #12072 | |
| WorkerGroupController | deleteWorkerGroupById | #12072 | |
| WorkerGroupController | queryWorkerAddressList | #12072 | |
| QueueController | queryList | #11067 | ✅ |
| QueueController | queryQueueListPaging | #11067 | ✅ |
| QueueController | createQueue | #11067 | ✅ |
| QueueController | updateQueue | #11067 | ✅ |
| QueueController | verifyQueue | #11067 | ✅ |
| EnvironmentController | createEnvironment | #12075 | |
| EnvironmentController | updateEnvironment | #12075 | |
| EnvironmentController | queryEnvironmentByCode | #12075 | |
| EnvironmentController | queryEnvironmentListPaging | #12075 | |
| EnvironmentController | deleteEnvironment | #12075 | |
| EnvironmentController | queryAllEnvironmentList | #12075 | |
| EnvironmentController | verifyEnvironment | #12075 | |
| ClusterController | createProject | ||
| ClusterController | updateCluster | ||
| ClusterController | queryClusterByCode | ||
| ClusterController | queryClusterListPaging | ||
| ClusterController | deleteCluster | ||
| ClusterController | queryAllClusterList | ||
| ClusterController | verifyCluster | ||
| K8sNamespaceController | queryProjectListPaging | ||
| K8sNamespaceController | createNamespace | ||
| K8sNamespaceController | updateNamespace | ||
| K8sNamespaceController | verifyNamespace | ||
| K8sNamespaceController | delNamespaceById | ||
| K8sNamespaceController | queryUnauthorizedNamespace | ||
| K8sNamespaceController | queryAuthorizedNamespace | ||
| K8sNamespaceController | queryAvailableNamespaceList |
Scheduler
| Controller | Function | issue | status |
|---|---|---|---|
| SchedulerController | ALL | #11912 |
Are you willing to submit a PR?
- Yes I am willing to submit a PR!
Code of Conduct
- I agree to follow this project's Code of Conduct
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
DSIPbackendfeaturenew featurenew featurehelp wantedExtra attention is neededExtra attention is needed
Type
Projects
Status
Done