Function parse

Exports

parse(content: any): { url: any }
Parse
Parameters
- content: any
  Raw URL content from the
Returns { url: any }
Object containing the sample request URL, or null if invalid
Api Sample Request
tag content to extract sample request URL

Extracts and validates the URL for sample request functionality. The URL can be a relative or absolute path that will be used to enable interactive testing of the API endpoint.

Api Sample Request
tag
Example: Basic sample request URL
```
// @apiSampleRequest https://api.example.com/v1/users
parse('https://api.example.com/v1/users')
// Returns: { url: 'https://api.example.com/v1/users' }
```
Example: Relative URL
```
// @apiSampleRequest /api/v1/users
parse('/api/v1/users')
// Returns: { url: '/api/v1/users' }
```
Example: Empty content
```
parse('')
// Returns: null
```
Since
4.0.0

Internal
- Defined in core/parsers/api_sample_request.ts:47