Java README Integration Guide Additions

[audrey-serpapi]

https://github.com/serpapi/marketing/issues/340
Summary of Changes:

• Added Quickstart, Features, Response Formats, new API spotlights, Configuration, Search Asynchronous, Documentation, and Contributing
• Introduced unit tests as source code to follow previous linked examples
• Introduced CONTRIBUTING.md to mirror Ruby docs
• Adjusted wording to mirror Ruby docs format
• Removed/Updated Usage, Inspiration, Changelog
• Updated README.md.erb
• Used uniform api key name and package namespace
• Remove persistent and timeout (unsupported features)
• Kept Java namings camel case
• Edited my own formatting and typos

[hilmanski]

I feel like we should start earlier. Here, we're assuming people already have "build.gradle" file. Can we start somewhere, like creating a new folder, then ....

[hilmanski]

Simlar steps you shared on the blog post https://serpapi.com/blog/how-to-scrape-google-search-results/#library-update-2026

[audrey-serpapi]

It seems like the repository we provide to be cloned in quickstart already has the gradle files and necessary setup ready. So, no gradle file editing is needed.
Would it be important to have a from scratch application section? Or just keep the main method as cloning our sample app with everything already set?

[hilmanski]

"You need a SerpApi account to obtain a key: https://serpapi.com/dashboard"

Duplication. We already mention it after the quickstart

[audrey-serpapi]

Removed, thanks

[hilmanski]

Why do we link it to a commit?

[audrey-serpapi]

This should not be there. We don't have an equivalent page for this so going to leave unlinked.

[hilmanski]

Maybe we should add a comment that this is a simulation. In real life, people may need to check process status instead of waiting for a specific time.

[audrey-serpapi]

Good idea. Done.

[hilmanski]

Any reasons we're dropping these sections:

• Migrations from the old library
• TLS / HTTPS and older JVMs

Please also create a summary of your PR changes in the description

[audrey-serpapi]

Fixing some previous failing tests. Working for a clean build then will ask for review.

[audrey-serpapi]

Hi @tanysheng @jvmvik @strzibny, could this get a review from you? Thanks

[strzibny]

Thanks @audrey-serpapi. I went through the changes and retested on latest Java 27. We still can't build with JDK 27 because of Gradle but that's expected.

Here are some things we should fix:

1, There is a mismatch between README.md and README.md.erb since the latter isn't updated and the contributor guide says to run make readme which would override our new changes.

2, You use API_KEY instead of SERPAPI_KEY in the new tests and because of that they won't be run on CI.

3, Let's keep example namespace everywhere so it's same:

package serpapi.example;
import serpapi.*;

4, persistent and timeout is configuration from the Ruby gem, but we don't have it here, so we need to skip it in README. The library has timeout but it's currently hardcoded.

5, Response format snippets are snaked_cased but should be CamelCased in Java (e.g. raw_html)

6, Google example likely need to use LocalDate

7, Actual package name is com.github.serpapi:serpapi-java not serp-api

Typos:

• "you_image" → "your_image"
• Broken markdown: [contributing guide](...CONTRIBUTING.md)) — extra ).
• Stray empty blockquote (> alone) before "A couple of notes"
• Inconsistent/broken indentation in the Google Shopping, Bing, Baidu, and Amazon examples

[audrey-serpapi]

Thank you for your review and feedback @strzibny! Have addressed 1-7 and typos.