azure api management apim dev portal - How to create staging environment in workspace? How to create a "dev portal" staging environment? How to develop and test a custom widget in the dev-staging environment

Question

20230723 azure api management apim dev portal - How to create staging environment dev portal in workspace? How to create a "dev portal" staging environment? How to develop and test a custom widget in the dev-staging environment

Since “workspace” is provided in the apim developer plan, it was confirmed that settings for the dev staging environment can be set using the workspace function even if not all options are available, and it is currently being used for staging development. But I couldn't find "dev portal settings" in the workspace. Even after upgrading the apim plan price, I couldn't find "content" that the dev portal could be set up for staging inside the workspace.

"apim dev portal development process" - "dev staging production development process" Is there any operating know-how?

Is there such a thing as best practices?

Is there a way to develop and manage the dev portal development code or custom widget development code by linking it with a specific repo on github (main repo - production env, develop repo - staging dev env)?

⇒ I want to test the development first in the "dev portal" staging environment, and when the function is complete, I want to deploy to the "dev portal" production environment by simply pressing a simple command or button. If possible, I do not want to use a separate hosting exclusively for "dev portal", and I try to use the hosting provided by apim.

---

Korean

아 한글로 써도 쉬운 내용도 아닌데, 영어로 질문쓰기가 너무 어렵네요 ㅠㅠ;

20230723 azure api management apim dev portal - workspace에서 staging 환경 만드는 방법? "dev portal" staging 환경 만드는 방법은? dev-staging 환경에서 custom widget을 개발테스트 하는 방법

안녕하세요 나는 azure api management - Developer plan을 이용하고 있습니다.

apim developer plan에는 “workspace”를 제공하고 있어서, dev staging 환경용 설정을 모든 옵션은 아니어도 workspace 기능을 이용해서 설정 가능하게 되어 있는 것을 확인하였고, 현재 staging 개발용으로 이용중입니다. 하지만 workspace에서 "dev portal 설정"은 찾을 수 없었습니다. apim plan 가격을 업그레이드 해도, workspace내부 에서 dev portal을 staging용으로 설정 할 수 있다는 "내용"은 찾을 수 없었습니다.

"apim dev portal 개발 프로세스" - "dev staging production 개발 프로세스" 운영 노하우 best practice 같은게 있나요? 이런 내용은 docs를 아무리 찾아봐도 없다;

Is there such a thing as best practices?

dev portal 개발 code, 또는 custom widget 개발 code를, github 특정 repo와 연동시켜서 (main repo - production env, develop repo - staging dev env) 개발 관리 하는 방법이 있나요? ⇒ "dev portal" staging 환경에서 먼저 개발 테스트를 하고, 기능완성이 되면, production 환경으로 간단한 명령어나 버튼만 누르면 "dev portal" production 환경에 배포되게 하고 싶습니다. 가능하면 "dev portal" 전용 별도의 호스팅은 이용하고 싶지 않고, apim에서 기본적으로 제공되는 호스팅을 이용하려고 한다.

Answer 1

kshepic Thanks for posting your question in Microsoft Q&A. The workspaces aren't surfaced to the developer portal and the reason has been described here. However, you can publish API/Products from the workspaces to the develpor portal.

Based on the description, you would like to know how to develop a portal custom widget in the repo separately Dev vs Prod for the managed version. Currently, you can create a custom widget in your own repo/environment based on scaffolder and tools and configure the widget in the developer portal. To make the widget available in the production, you would need to republish the developer portal but unfortunately, there is no option to have two different repos for the managed version (doc reference).

In general, it is recommended to have different APIM instances for each environment such as Dev, Staging and Prod and you can maintain the developer portal changes for each environment accordingly. Then you can use automated migration script to move the changes between two APIM instances and refer Automate developer portal deployments for more info.

For any feedback regarding this feature, please submit it via https://aka.ms/apimwish to the product team and others with similar interest can upvote your idea. This will help our product team understand the customer interests and prioritize the features accordingly. I will also submit your feedback to our product team internally. I hope this helps and let me know if any questions.

---

If you found the answer to your question helpful, please take a moment to mark it as "Yes" for others to benefit from your experience. Or simply add a comment tagging me and would be happy to answer your questions.