Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add rest api creation with apk deployer doc #559

Merged
merged 1 commit into from
Apr 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 0 additions & 36 deletions en/docs/create-api/create-and-deploy-apis/create-and-deploy-api.md

This file was deleted.

36 changes: 0 additions & 36 deletions en/docs/create-api/create-and-deploy-apis/direct-deploy.md

This file was deleted.

12 changes: 0 additions & 12 deletions en/docs/create-api/create-and-deploy-apis/generate-apk-conf.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Follow the instructions below to create a REST API using the APK deployer REST API.

{!templates/create-apk-conf-api.md!}

Update the APK configuration file with additional API configurations as needed, such as Rate limits, CORs configurations.

{!templates/post-create-apk-conf-api.md!}

2 changes: 1 addition & 1 deletion en/docs/get-started/quick-start-guide-with-cp.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Apart from the above API definition file, we also need an `apk-conf` file that d
2. You will get the apk-conf file content as the response. Save this content into a file named `EmployeeService.apk-conf`.

!!! Important
We recommend installing the [APK Config Language Support Visual Studio Code (VS Code) extension](../create-api/create-and-deploy-apis/apk-conf-lang-support.md) to edit the APK Configuration file.
We recommend installing the [APK Config Language Support Visual Studio Code (VS Code) extension]({{base_path}}/en/latest/api-management-overview/apk-conf-lang-support/) to edit the APK Configuration file.


### Deploy the API in APK DataPlane
Expand Down
2 changes: 1 addition & 1 deletion en/docs/get-started/quick-start-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ Apart from the above API definition file, we also need an `apk-conf` file that d
2. You will get the apk-conf file content as the response. Save this content into a file named `EmployeeService.apk-conf`.

!!! Important
We recommend installing the [APK Config Language Support Visual Studio Code (VS Code) extension](../create-api/create-and-deploy-apis/apk-conf-lang-support.md) to edit the APK Configuration file.
We recommend installing the [APK Config Language Support Visual Studio Code (VS Code) extension]({{base_path}}/en/latest/api-management-overview/apk-conf-lang-support/) to edit the APK Configuration file.


### Generate an access token to invoke APIs
Expand Down
11 changes: 5 additions & 6 deletions en/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -89,18 +89,17 @@ nav:
- Overview: api-management-overview/create-api-overview.md
- Via REST API: api-management-overview/tools-for-api-development.md
- Via CRs: api-management-overview/create-api-using-crs.md
- APK Config Language Support Plugin: api-management-overview/apk-conf-lang-support.md
- Develop and Deploy API:
- Rest APIs:
- Via REST API:
- Generate API Configuration file: create-api/create-and-deploy-apis/generate-apk-conf.md
- Generate K8s custom resources and Deploy: create-api/create-and-deploy-apis/create-and-deploy-api.md
- Direct Deploy into K8s Server: create-api/create-and-deploy-apis/direct-deploy.md
- Undeploy API: create-api/create-and-deploy-apis/direct-undeploy.md
- API Config Language Support Plugin: create-api/create-and-deploy-apis/apk-conf-lang-support.md
- Via REST API: create-api/create-and-deploy-apis/rest/create-rest-api-using-rest-api.md
- Via CRs: create-api/create-and-deploy-apis/rest/create-rest-api-using-crs.md
- GraphQL APIs:
- Via CRs: create-api/create-and-deploy-apis/graphql/create-graphql-api-using-crs.md
# todo(amali) add rest of the links
- Undeploy API:
- Via REST API: undeploy/direct-undeploy.md
#todo(amali) add the CRs link
- Manage Endpoint:
- Define Endpoint: develop-and-deploy-api/endpoints/prod-sand-endpoints.md
- Manage Certificate: create-api/manage-service-endpoint/manage-certificate.md
Expand Down