Documentation To Setup Quotes API in Your PHP/JAVA Projects - KrishnaIP

<?php
// Include necessary libraries
require 'vendor/autoload.php'; // Assuming Composer for libraries
use GuzzleHttp\Client;

// API base URL with API key included
$apiUrl = 'https://krishnaip.net/api/quotes/ApiKey'; // Replace with your actual API key

// No need for separate headers array
$headers = [];

class QuotesResponse
{
    public $code;
    public $status;
    public $title;
    public $quotes;
    public $nextPageUrl;
    public $prevPageUrl;

    public function __construct($data)
    {
        $this->code = $data['code'];
        $this->status = $data['status'];
        $this->title = $data['title'];
        $this->quotes = array_map(function ($quote) {
            return new Quote($quote);
        }, $data['quotes']);
        $this->nextPageUrl = $data['next_page_url'];
        $this->prevPageUrl = $data['prev_page_url'];
    }
}

class Quote
{
    public $quote;
    public $author;
    public $category;

    public function __construct($data)
    {
        $this->quote = $data['quote'];
        $this->author = $data['author'];
        $this->category = $data['category'];
    }
}

function fetchQuotes($page = 1)
{
    global $apiUrl, $headers;

    $url = $apiUrl . '?page=' . $page;

    $client = new Client();
    $response = $client->get($url, ['headers' => $headers]);

    $data = json_decode($response->getBody()->getContents(), true);

    return new QuotesResponse($data);
}

// Fetch quotes from the first page
$quotesResponse = fetchQuotes();

// Check for successful response
if ($quotesResponse->code === 200 && $quotesResponse->status === 'success') {
    // Display quotes
    foreach ($quotesResponse->quotes as $quote) {
        echo $quote->quote . " - " . $quote->author . " (" . $quote->category . ")" . PHP_EOL;
    }

    // Check for next page
    if ($quotesResponse->nextPageUrl) {
        // Fetch and display quotes from the next page
        $nextPageResponse = fetchQuotes($page + 1);
        // ... display or handle quotes as needed
    }
} else {
    echo "Error: " . $quotesResponse->message;
}

1. Add Retrofit and GSON dependencies:

Add the following dependencies to your build.gradle file:

dependencies {
    implementation 'com.squareup.retrofit2:retrofit:2.9.0'
    implementation 'com.squareup.retrofit2:converter-gson:2.9.0'
}

2. Create a Quote interface:

Create a Quote class to represent the data structure of a quote returned by the API:

public class Quote {
    private String quote;
    private String author;
    private String category;

    public Quote(String quote, String author, String category) {
        this.quote = quote;
        this.author = author;
        this.category = category;
    }

    public String getQuote() {
        return quote;
    }

    public void setQuote(String quote) {
        this.quote = quote;
    }

    public String getAuthor() {
        return author;
    }

    public void setAuthor(String author) {
        this.author = author;
    }

    public String getCategory() {
        return category;
    }

    public void setCategory(String category) {
        this.category = category;
    }
}

3. Define the API interface:

Create an interface for your API service with a method to retrieve quotes:

public interface QuotesApi {
    @GET('/api/quotes/ApiKey')
    Call<QuotesResponse> getQuotes();
}

4. Define a QuotesResponse class:

This class represents the full response structure, including pagination information:

public class QuotesResponse {
    private String code;
    private String status;
    private String title;
    private List<Quote> quotes;
    private String nextPageUrl;
    private String prevPageUrl;

    public List<Quote> getQuotes() {
    return quotes;
    }

    public String getNextPageUrl() {
    return nextPageUrl;
    }

    public String getPrevPageUrl() {
    return prevPageUrl;
    }
}

5. Create Retrofit instance:

Create a Retrofit instance with the base URL and GSON converter:

Retrofit retrofit = new Retrofit.Builder()
        .baseUrl("https://krishnaip.net/")
        .addConverterFactory(GsonConverterFactory.create())
        .build();

6. Implement API call:

Create a class or method to perform the API call:

public class ApiManager {
    private QuotesApi api;

    public ApiManager() {
        api = retrofit.create(QuotesApi.class);
    }

    public void getQuotes(SuccessCallback<List<Quote>> successCallback,
                            ErrorCallback errorCallback) {
        Call<QuotesResponse> call = api.getQuotes();
        call.enqueue(new Callback<QuotesResponse>() {
            @Override
            public void onResponse(Call<QuotesResponse> call, Response<QuotesResponse> response) {
                if (response.isSuccessful()) {
                    QuotesResponse quotesResponse = response.body();
                    if (quotesResponse != null) {
                        successCallback.onSuccess(quotesResponse.getQuotes());
                    } else {
                        errorCallback.onError("Empty response body");
                    }
                } else {
                    errorCallback.onError("Error occurred: " + response.code());
                }
            }

            @Override
            public void onFailure(Call<QuotesResponse> call, Throwable t) {
                errorCallback.onError("API error: " + t.getMessage());
            }
        });
    }

    public interface SuccessCallback<T> {
        void onSuccess(T data);
    }

    public interface ErrorCallback {
        void onError(String message);
    }
}

7. Call the API and handle response:

In your activity or fragment, call the getQuotes method and handle the success and error callbacks:

ApiManager apiManager = new ApiManager();
apiManager.getQuotes(new ApiManager.SuccessCallback>() {
    @Override
    public void onSuccess(List quotes) {
        // Update your UI with the list of quotes
        recyclerView.setAdapter(new QuotesAdapter(quotes));
    }
}, new ApiManager.ErrorCallback() {
    @Override
    public void onError(String message) {
        // Show error message to the user
        Toast.makeText(getApplicationContext(), message, Toast.LENGTH_SHORT).show();
    }
});

8. Adapter for RecyclerView:

Create an adapter to display the quote data in a RecyclerView:

public class QuotesAdapter extends RecyclerView.Adapter<QuotesAdapter.QuoteViewHolder> {
    private List<Quote> quotes;

    public QuotesAdapter(List<Quote> quotes) {
        this.quotes = quotes;
    }

    @Override
    public QuoteViewHolder onCreateViewHolder(ViewGroup parent, int viewType) {
        View view = LayoutInflater.from(parent.getContext()).inflate(R.layout.quote_item, parent, false);
        return new QuoteViewHolder(view);
    }

    @Override
    public void onBindViewHolder(QuoteViewHolder holder, int position) {
        Quote quote = quotes.get(position);
        holder.quoteText.setText(quote.getQuote());
        holder.authorText.setText(quote.getAuthor());
    }

    @Override
    public int getItemCount() {
        return quotes.size();
    }

    public class QuoteViewHolder extends RecyclerView.ViewHolder {

        TextView quoteText;
        TextView authorText;

        public QuoteViewHolder(View itemView) {
            super(itemView);
            quoteText = itemView.findViewById(R.id.quote_text);
            authorText = itemView.findViewById(R.id.author_text);
        }
    }
}

Explanation:

• This adapter extends RecyclerView.Adapter and defines a QuoteViewHolder class.
• The onCreateViewHolder method inflates the quote item layout for each ViewHolder.
• The onBindViewHolder method binds the quote data (text and author) to the corresponding views in the ViewHolder.
• The getItemCount method returns the number of quotes in the list.
• The QuoteViewHolder class holds references to the TextViews displaying the quote and author details.

9. Create XML Layout For Adapter Class:

Create an adapter layout view quote_item.xml

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:orientation="vertical"
    android:padding="16dp">

    <TextView
        android:id="@+id/quote_text"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:text="Quote Text"
        android:textSize="18sp"
        android:textColor="@android:color/black" />

    <TextView
        android:id="@+id/author_text"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:text="Author Name"
        android:textSize="14sp"
        android:textColor="@android:color/gray"
        android:layout_marginTop="8dp" />
</LinearLayout>

Explanation:

• The LinearLayout defines a vertical container for the quote and author.
• The quote_text TextView displays the quote text with larger size and black color.
• The author_text TextView displays the author name with smaller size and gray color.
• The padding attribute adds space around the text views for better visual presentation.

Customization:

• You can change the text sizes, colors, fonts, and layout attributes to match your app's design.
• You can add additional elements like an image or a rating for each quote.
• Remember to update the QuotesAdapter class with the actual IDs of your TextViews if you change them in the layout.

Modify api.getQuotes method:

public void getQuotes(SuccessCallback<List<Quote>> successCallback, ErrorCallback errorCallback) {
    Call<QuotesResponse> call = api.getQuotes();
    call.enqueue(new Callback<QuotesResponse>() {
        @Override
        public void onResponse(Call<QuotesResponse> call, Response<QuotesResponse> response) {
            QuotesResponse quotesResponse = response.body();
            if (quotesResponse != null) {
                if (quotesResponse.getStatus().equals("success")) {
                    successCallback.onSuccess(quotesResponse.getQuotes());
                } else {
                    errorCallback.onError("API error: " + quotesResponse.getStatus());
                }
            } else {
                errorCallback.onError("Empty response body");
            }
        }

        @Override
        public void onFailure(Call<QuotesResponse> call, Throwable t) {
            errorCallback.onError("Network error: " + t.getMessage());
        }
    });
}