Search an OpenAPI File / Add API to search

Open Q&A
, ,
#1

Looking for some advice on how to integrate my API reference into Algolia. I have an OpenAPI file that I can convert to JSON if needed. But I am not sure how to go about getting the data out. Or if that is even the best path. I’d like to pull in:

  • API Path
  • Description
  • Code Samples (which are kept separate and just use an external reference to pull them in)

Any help or guidance is appreciated.

Set up

  • I do not have the web scraper.
  • Currently, the articles are converted into a JSON output.
#2

Hi Tatiana,

A JSON file is a great place to start. You can find examples on the Algolia documentation on how to index from a JSON file with any of our 11 API clients: Importing with the API | How to | Sending and Managing Data | Guide | Algolia Documentation

I’d also recommend checking this section to figure out what to keep, what to remove, and what to transform in your records before sending them to Algolia.