https://github.com/codefromanywhere/openapi-search

🔎 Search Engine for Web APIs
https://github.com/codefromanywhere/openapi-search

api api-directory oas openapi openapi3 opendata rest-api search search-engine swagger

Last synced: 3 months ago
JSON representation

🔎 Search Engine for Web APIs

• Host: GitHub
• URL: https://github.com/codefromanywhere/openapi-search
• Owner: CodeFromAnywhere
• Created: 2023-01-16T10:24:32.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-29T06:35:40.000Z (4 months ago)
• Last Synced: 2024-11-07T11:02:35.482Z (3 months ago)
• Topics: api, api-directory, oas, openapi, openapi3, opendata, rest-api, search, search-engine, swagger
• Language: TypeScript
• Homepage: https://openapisearch.com
• Size: 560 KB
• Stars: 38
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
OpenAPI-Search combines multiple OpenAPIs in a fast, organized, and searchable interface.

OpenAPIs are effectively closed if there isn't an accessible way to find and use them. Big commercial API directories such as https://rapidapi.com are currently dominating the search results and the # of APIs indexed, leading many developers to a non-open API gateway. Open Source is far behind.

The best OpenAPI directory as of yet is https://apis.guru but this doesn't even reach 10% of the amount of listed APIs and there is many room for improvement.

The vision of https://openapisearch.com is to make OpenAPIs truly open by making it accessible (easy to find what you're looking for) and improving listing quality.

![](explorer.drawio.png)

# Goals

Targeted improvements compared to https://apis.guru:

- Semantic search

- Related APIs

- Programmatic Registry

- Improved Website

Wishlist:

- E2E Testing of OpenAPIs

- AI Crawler for API Discovery

- AI Crawler to augment OpenAPI Metadata

  - Adds authentication + scope info

  - Adds useful links

  - Adds reviews

  - Adds pricing info, ratelimit info, etc

## Non-goals

- Create a docs reference website like [readme.com](https://readme.com) (there are many) - for this we're using stoplight now.

- Add weird custom logic that is non-standard to the OpenAPI. Instead, I aim to create a layer on top of openapis to improve the implementation of the standard. I'll use [actionschema](https://actionschema.com) for this.

# Sync process

![](sync.drawio.svg)

This is the intended daily synchronisation process which ensures search results are up-to-date and of high quality. Besides filtering out invalid OpenAPIs, OpenAPISearch also generates useful metadata so enhance listing quality.

# TODO

# Calculated data

- Bring back openapiSummary without dependency

- Create info.x-generated-description for all items based on summary and other metadata.

- Create categories using LLM too (using x-generated-description and hardcoded categories)

- 10 related providers out of 50 using search + LLM

- Reindex all with generated description in data

# MAKING ACTIONSCHEMA STABLE:

1. At semantic-operation-search, sync with metadata

2. ActionSchema Lucky search should work and be fast

For more ideas and wishes, see [backlog](BACKLOG.md)