77 lines
2.1 KiB
Markdown
77 lines
2.1 KiB
Markdown
 
|
# How to Find the Correct RapidAPI Endpoint
|
||
|
|
|
||
|
|
## Step 1: Go to RapidAPI Playground
|
||
|
|
|
||
|
|
Visit: https://rapidapi.com/teachjesusapp/api/complete-study-bible/playground/apiendpoint_c726eca5-3238-43bb-bee5-c17877e23d92
|
||
|
|
|
||
|
|
## Step 2: Find the Endpoint
|
||
|
|
|
||
|
|
1. Look at the left sidebar - you'll see different endpoints listed
|
||
|
|
2. Click on endpoints that look like they might search for words (e.g., "Search Word", "Get Word", "Word Definition")
|
||
|
|
3. Look at the **endpoint URL** shown - it will be something like:
|
||
|
|
- `/api/word/{word}`
|
||
|
|
- `/words/search`
|
||
|
|
- `/search/word`
|
||
|
|
- etc.
|
||
|
|
|
||
|
|
## Step 3: Test It
|
||
|
|
|
||
|
|
1. Enter a test word (like "love") in the parameters
|
||
|
|
2. Click "Test Endpoint"
|
||
|
|
3. If it works, you'll see the response data
|
||
|
|
|
||
|
|
## Step 4: Copy the Endpoint Path
|
||
|
|
|
||
|
|
Copy the exact endpoint path (the part after the domain). For example:
|
||
|
|
- If the full URL is: `https://complete-study-bible.p.rapidapi.com/api/word/love`
|
||
|
|
- The endpoint path is: `/api/word/{word}` or `/api/word/love` (replace `love` with `{word}`)
|
||
|
|
|
||
|
|
## Step 5: Test It in Your App
|
||
|
|
|
||
|
|
Once you have the endpoint, test it:
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
// Example: if the endpoint is /api/word/{word}
|
||
|
|
await window.testRapidAPICustomEndpoint('/api/word/{word}', 'love');
|
||
|
|
|
||
|
|
// Or if it's /words/search?word=love
|
||
|
|
await window.testRapidAPICustomEndpoint('/words/search?word={word}', 'love');
|
||
|
|
```
|
||
|
|
|
||
|
|
## Step 6: Update the Code
|
||
|
|
|
||
|
|
Once you find a working endpoint, tell me what it is and I'll update `rapidapi-study-bible.js` to use it!
|
||
|
|
|
||
|
|
## Common Endpoint Patterns
|
||
|
|
|
||
|
|
RapidAPI APIs often use:
|
||
|
|
- `/api/{resource}/{id}` - RESTful pattern
|
||
|
|
- `/api/{resource}/search` - Search pattern
|
||
|
|
- `/api/search?q={query}` - Query parameter pattern
|
||
|
|
- `/v1/{resource}/{id}` - Versioned API pattern
|
||
|
|
|
||
|
|
Look for endpoints that mention:
|
||
|
|
- "word"
|
||
|
|
- "search"
|
||
|
|
- "definition"
|
||
|
|
- "lookup"
|
||
|
|
- "find"
|
||
|
|
|
||
|
|
## Still Can't Find It?
|
||
|
|
|
||
|
|
1. Check the API documentation tab on RapidAPI
|
||
|
|
2. Look at the "Endpoints" section
|
||
|
|
3. Try clicking through different endpoints to see what they do
|
||
|
|
4. The endpoint name/description usually gives hints about what it does
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|