feat: Add local API server #4480
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This change introduces a local API server to serve the list of public APIs from the `README.md` file in a structured JSON format. The previous public API, hosted at `api.publicapis.org`, is no longer accessible. This new server provides a local alternative for users who want to consume the API data programmatically. The changes include: - A Python script `scripts/parse_readme.py` to parse the `README.md` and generate `scripts/apis.json`. - A Flask-based API server `scripts/api_server.py` that serves the generated JSON data. - Updated `scripts/requirements.txt` with the Flask dependency. - Documentation in `README.md` on how to set up and run the local server.
This change introduces a web dashboard that allows you to manually sync your forked repository with the parent repository. The dashboard provides a user-friendly way to keep your local API data up-to-date with the latest changes from the `public-apis/public-apis` repository. The changes include: - A new `dashboard` directory with HTML, CSS, and JavaScript files for the UI. - An updated `scripts/api_server.py` to serve the dashboard and handle the sync logic. - The sync logic uses `git` commands to fetch and merge from the parent repository and then rebuilds the `apis.json` data file. - Updated documentation in the `README.md` to explain how to use the new dashboard.
This change introduces an automated periodic sync feature to the local API server. The server now uses a scheduler to automatically sync the forked repository with the parent repository every 24 hours. This ensures that the local API data is kept up-to-date without manual intervention. The changes include: - Added a scheduler to `scripts/requirements.txt`. - Updated `scripts/api_server.py` to include a background scheduler that runs the sync task. - Refactored the sync logic into a shared function. - Updated the dashboard to display the next scheduled sync time. - Updated documentation in `README.md` to explain the new automated sync feature.
r31545084-sudo
approved these changes
Aug 5, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change introduces a local API server to serve the list of public APIs from the
README.mdfile in a structured JSON format.The previous public API, hosted at
api.publicapis.org, is no longer accessible. This new server provides a local alternative for users who want to consume the API data programmatically.The changes include:
scripts/parse_readme.pyto parse theREADME.mdand generatescripts/apis.json.scripts/api_server.pythat serves the generated JSON data.scripts/requirements.txtwith the Flask dependency.README.mdon how to set up and run the local server.