Coder Social home page Coder Social logo

How to add api specs by product about api-portal HOT 11 OPEN

azure avatar azure commented on July 4, 2024 1
How to add api specs by product

from api-portal.

Comments (11)

azaslonov avatar azaslonov commented on July 4, 2024

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.

boyavenkatesh avatar boyavenkatesh commented on July 4, 2024

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.

azaslonov avatar azaslonov commented on July 4, 2024

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.

boyavenkatesh avatar boyavenkatesh commented on July 4, 2024

Got it . Will it be considered as future enhancement .

Cool, will wait for merge .

from api-portal.

azaslonov avatar azaslonov commented on July 4, 2024

Can't promise, it looks very case-specific, but let's track it as an enhancement at least.

from api-portal.

mikebudzynski avatar mikebudzynski commented on July 4, 2024

@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.

boyavenkatesh avatar boyavenkatesh commented on July 4, 2024

@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.

mikebudzynski avatar mikebudzynski commented on July 4, 2024

@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.

boyavenkatesh avatar boyavenkatesh commented on July 4, 2024

@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 avatar boyavenkatesh commented on July 4, 2024

@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.

@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 avatar mikebudzynski commented on July 4, 2024

@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)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.