Comments (11)
Hi @boyavenkatesh, just to clarify, do you want to have different API spec collections/folders to be shown on different pages depending on the page path?
Regarding the error, do you mind copy it from F12 console, just to be on the same page?
from api-portal.
correct . for example /product1-apis will show only the specs for product1 and /product2-apis should only show porduct2 apis .
Regarding the error :
anchorUtils.ts:22 Uncaught (in promise) Error: Parameter "pageContent" not specified.
at Function.getHeadingNodes (anchorUtils.ts:22)
at PageSelector.eval (pageSelector.ts:125)
at Generator.next ()
at fulfilled (pageSelector.ts:14)
from api-portal.
Got it. So short answer - not out of the box. This will require some change into this operation.
Regarding the bug, looks like we fixed it in upstream libraries, so we'll merge it soon and check that issue.
from api-portal.
Got it . Will it be considered as future enhancement .
Cool, will wait for merge .
from api-portal.
Can't promise, it looks very case-specific, but let's track it as an enhancement at least.
from api-portal.
@boyavenkatesh, a potentially better way would be to tag APIs and then create links to the API list with a preset tag filter. Although the API list already supports passing tag filters as URL parameters, the API Portal doesn't support tags from the OpenAPI files.
from api-portal.
@mikebudzynski , we are looking to use Tags from Open API files , not via URL parameters . Unfortunately , API portal does not support tags from OpenAPI files as you noted.
from api-portal.
@boyavenkatesh, I meant that the API list widget already supports applying the tag filters from the URL parameters. For example, https://contoso.com/apis#tags=testtag
could automatically filter the list of APIs by the testtag
tag. With this feature, you could create links to your offerings, by categorizing the APIs with tags.
Currently, the missing part is the lack of support for tags from OpenAPI files in the API Portal. For comparison, in Azure API Management's developer portal, which uses a similar widget, the tags are fetched from the API Management service and this end-to-end solution is already possible.
from api-portal.
@mikebudzynski got that . We are not keen to add tags as URL filter all existing APIs . Instead all put API definitions have tag element, which makes sense to use them rather adding this URL paramter.
from api-portal.
@boyavenkatesh, I meant that the API list widget already supports applying the tag filters from the URL parameters. For example,
https://contoso.com/apis#tags=testtag
could automatically filter the list of APIs by thetesttag
tag. With this feature, you could create links to your offerings, by categorizing the APIs with tags.Currently, the missing part is the lack of support for tags from OpenAPI files in the API Portal. For comparison, in Azure API Management's developer portal, which uses a similar widget, the tags are fetched from the API Management service and this end-to-end solution is already possible.
@mikebudzynski as per your comment https://contoso.com/apis#tags=testtag . Do you mean to have an URL parameter called tags for every api definition in Open API file ? Or is it some thing done in Portal configuration
from api-portal.
@mikebudzynski as per your comment https://contoso.com/apis#tags=testtag . Do you mean to have an URL parameter called tags for every api definition in Open API file ? Or is it some thing done in Portal configuration
You can assign tags to APIs in the Azure portal - it can be one tag per API or a set of tags per API. Those tags are then surfaced in the developer portal.
from api-portal.
Related Issues (18)
- Question: will the two kinds of Dev-Portals content-wise be compatible? HOT 3
- Cannot run local HOT 4
- Consider supporting GraphQL SDL HOT 6
- Configure code splitting to reduce loading time for output files HOT 1
- Clarify development path compared to self-hosted version HOT 3
- openApi docs added - No operations found HOT 4
- Support for publishing to GitHub Pages with URL suffix HOT 2
- "npm start" results in error "TS2339: Property 'getType' does not exist on type 'typeof import...." HOT 1
- Add support for YAML format of OpenAPI specification HOT 3
- please ignore
- Provide CODEOWNERS HOT 1
- Local install not working, nor advanced deployments HOT 6
- This repo is missing important files HOT 6
- Soap API
- Update GitHub Actions to use Node 16 HOT 1
- Seeking clarity on API-Portal vs https://github.com/Azure/api-management-developer-portal HOT 1
- Errors deploying gh-pages branch HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from api-portal.