Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: create crawler api server #52

Merged
merged 9 commits into from
Dec 25, 2023

Conversation

adityak74
Copy link
Contributor

@adityak74 adityak74 commented Nov 22, 2023

This PR creates an express server that exposes /crawl endpoint that accepts the config as a post-request body and responds to the crawled json.

Swagger API Documentation at: /api-docs

Doesn't support concurrency yet. - #120

  • Create a basic structure for the server
  • Modularize port and host for deployments
  • Add validations for config parsing and conversion.
  • Swagger UI for API documentation

Fixes: #43

@marcelovicentegc marcelovicentegc added the enhancement New feature or request label Dec 4, 2023
@BikeF
Copy link

BikeF commented Dec 5, 2023

I did not run your changes, but I am concerned that this API does not support concurrent calls. He cannot be used simultaneously

@databill86
Copy link

databill86 commented Dec 14, 2023

Any news on this feature ? :)

@adityak74
Copy link
Contributor Author

@databill86 I am working on the docker file, facing some small issues, I should get it in a couple of days.

@adityak74
Copy link
Contributor Author

@databill86 - This PR is ready to be reviewed. I will attempt to Dockerize in another PR. This should get us started with the API running locally.

@steve8708
Copy link
Contributor

steve8708 commented Dec 25, 2023

looks great, thanks for the contribution @adityak74! would be great if you could send a followup PR updating the README about how to use this as an API as well, so new users know what is possible and how to use these updates

@steve8708 steve8708 merged commit 4ccf3b3 into BuilderIO:main Dec 25, 2023
3 checks passed
Copy link

🎉 This PR is included in version 1.2.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@adityak74
Copy link
Contributor Author

@steve8708 - Thanks and sure I will create README PR soon.

hirsaeki pushed a commit to hirsaeki/gpt-crawler-y-upstream that referenced this pull request Mar 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Expose the service as a REST API
5 participants