Azure / API-Portal

API Portal lets you create and publish a customized site with API documentation, for free and without writing any code.
MIT License
173 stars 141 forks source link

Seeking clarity on API-Portal vs https://github.com/Azure/api-management-developer-portal #70

Closed sitestudio closed 1 year ago

sitestudio commented 1 year ago

We are currently evaluating using this repo as a "mocked responses only" front end for our API portal by integrating it into a larger capability that includes documentation served from GitHub via (GitHub Pages).

We have also looked at integrating https://github.com/Azure/api-management-developer-portal however that seems to require:

  1. AADB2C for external users if we try to host inside GitHub Pages
  2. AAD for internal corporate users
  3. Monthly payments for having it hosted on Azure or at least via Azure Storage if we set up some other internal self-hosting (VNet etc).

Requiring authentication to be able to view mocked APIs feels onerous.

Also, thus far I haven't been able to get an actual "Try It Out" page to show for this current repo. I can only get the designer up and see that changes are saved to a json file.

Going through the source code for the two repos there seems to be some divergence now and not sure what the direction is going forward.

Could someone please advise if there will soon be more work put into this API-Portal repo and what might come out of it?

sitestudio commented 1 year ago

Managed to get it all working by messing around with various things including the check-in yaml file.