apisof.net icon indicating copy to clipboard operation
apisof.net copied to clipboard

Consider adding an API for search

Open vcsjones opened this issue 1 year ago • 0 comments

It would be handy if apisof.net exposed an API for searching and getting some basic information about the API in the search result. This was useful to me in the Microsoft Learn API catalog to build a Raycast extension to search the .NET API catalog quickly. For example

https://github.com/dotnet/apisof.net/assets/361677/640a6574-96a6-4330-bc9a-50e9d6e728a3

I'd like to extend my Raycast extension (or maybe build a new one) to make it easy to quickly bring up APIs from Raycast.

My proposal would be for the URL to be something like https://apisof.net/search/v1/{term}

The search on home page is what I am trying to replicate, so the response might look something like

{
    "results": [
     {
        "fullname": "System.Security.Cryptography.AesGcm",
        "kind": "type",
        "url": "https://apisof.net/catalog/97baaebcb0bdf110633c544fdc3ccbbd"
     },
     {
        "fullname": "System.Security.Cryptography.AesGcm.Dispose",
        "kind": "method",
        "url": "https://apisof.net/catalog/a39427ca2fce5b201fdb5911b7119050"
     }
    ]
}

Or, perhaps a different question, how can I achieve the results of creating a search plugin for Raycast for apisof.net?

vcsjones avatar May 02 '24 00:05 vcsjones