GitHub OpenAPI Search

[jansche]

Summary: Provide a robust yet easy way to search Github for Swagger and OpenAPI definitions. Understanding that there is a lot of noise available, that we only care about OpenAPIs that validate, and that the Github API has rate limits that require you to automate the crawling over time. Providing a robust open-source solution that will crawl public Github repositories for machine-readable API definitions.

Skills: Knowledge of the Github API, and the OpenAPI specification.

Expected Outcomes: An open-source API that allows you to pass in search parameters and then utilize the GitHub API to perform the search, helping simplify the search interface, make rate limits visible as part of the response, and handle conducting a search in an asynchronous way, allowing the user to make a call to initiate, but then separate calls to receive results over time as results come in, helping show outcomes over time.

Mentors: @anshuljain03 + 1-2 additional mentors

Project Repo: https://github.com/postman-open-technologies/openapi-github-search

Size of Project: 175h

Rating: Easy

[jansche]

This may be merged with #7, to create a project that suffices the requirement of being a 175h project. Or merge with #6 and #7 to become a 350h project. @kinlane

[sambhavgupta0705]

Hi @jansche , I am Sambhav Gupta, a full stack MERN web developer . Apart from it I have basic understanding of OpenAPI and have worked with GitHub API in past and also work with postman in my day to day for project building.

I like the Idea of developing a robust way of asynchronously searching for swaggers and machine readable API definitions by crawling over public GitHub repositories through GitHub API and provide the desired result to the user.
The idea of managing GitHub API for searching Open API and swaggers while managing the rate limits seems an interesting and seems to be an exciting part of this project.
Working with both GitHub API and Open API definitions at the same time seems a challenging and exciting part of this project.

As a mentor ,you can best of me by providing your guidance and giving regular feedback on my work by which I will be able to improve in areas where I lack. By communicating regularly we will be able to work in more efficient way and would also able to keep me motivated for the project.
I would value precise instructions and frequent feedback from my mentors as a mentee. As I work on the project, I would also value their accessibility for queries and assistance.

In my day to day life I use Notion and Google keep notes to keep my life organised. I write all the tasks at the start of the day and rate them priority wise and then work on them by assigning a specific time block to them. I am available on slack , Microsoft teams and google chats for communication.In order to keep a track of my changes I use Git version control system.

At the end ,the project will help me improving my skills and API knowledge which will help me in future also.

[money8203]

Hey @jansche , I am currently a Postman Student leader and a junior web developer. I have had some experience with API's and Postman. Would love to work on the Open API initiative along with the amazing team at Postman!

I am interested about this project because of the opportunity to contribute to the development of a robust and open-source tool that can make it easier for developers to find and access Swagger and OpenAPI definitions on Github. I believe this project has the potential to save a lot of time and effort for developers who are looking for API definitions and help them focus more on building their own applications.

As mentors and project coordinators, you can get the best out of me by providing clear guidance and feedback on my work, and being available for any questions or concerns that I may have. Regular check-ins and communication would also be helpful in keeping me on track and motivated.

While working on this project, I hope to improve my understanding of the Github API and the OpenAPI specification. I also hope to develop my skills in developing open-source software and working collaboratively with other developers.

[ishaan812]

Hey @jansche , I already have some experience working with OpenAPI and and Github API. I think this is a great feature and in my personal use of Postman one of the pain points I currently experience is creating collections manually after cloning a public repo. What would be really helpful would to be to automaticaly curate a library of API's ready for testing for these repos.

This could also help to promote use of the documentation feature which is a feature I have been a fan of but seems a tad bit underused. I think this could help improve the whole Postman Ecosystem all-in-all just by implementing this relatively easy feature and further ease the migration from SwaggerUI to Postman which is a much better platform in my experience.

I also think merging this with #7 is a good idea since they might be similar tasks and have a lot of overlap. #6 #7 and #8 together they will help improve the Postman experience for pre-existing users using swagger and openapi.
I have a lot of experience of working in remote-first environments and would love to able to contribute to a product I use almost daily. I understand the importance of overcommunication and being able to correctly document and follow a process to achieve efficiency at a team level. I would love to know more about the task.

[jansche]

Hi folks,
we're currently coordinating mentors and will provide more details as well as answer questions beginning of next week (week of February 27). Please bear with us.
Best regards
Jan