We’re putting together a plan for finalizing our Dev Portal / Developer Experience and were wondering if you could offer guidance / best practice recommendations?
Essentially our goals are to:
So for example, I want us to have “API products” such as:
Now the thing is… some of these “API products” will likely encapsulate the same endpoints… All 3 API Products might need a “Get Addresses” call, for example.
So our question is… What is the best strategy for this in order to maximize reusability and minimize redundant configuration? A few considerations that are top of mind are:
Followup question for question #2
Thanks!
I agree with your perspective on 1-3 regarding products as a general approach. No need to have a separate proxy/virtual host for each product unless there's something specific you're trying to accomplish (and even then it would take some convincing).
For restricting access by role I have two things that may come in handy. First, if you're interested in controlling self-service access to APIs by role (e.g. only affiliate users can request an API key for the affiliate product) you can enable the included "DevConnect Limit API Product by Role" module in the administrative Modules section. This will create a new admin menu option under Configuration -> Dev Portal called "API Product Role Access". If you are creating SmartDocs for your API and want to limit access to the API based on user role, take a look at the article that @Chris Novak wrote on this subject.
Hope this helps!
User | Count |
---|---|
7 | |
2 | |
2 | |
2 | |
1 |