Markdown-Link-Extraktor-Beispiele

# Basic Markdown Links

This document demonstrates the fundamental link syntax in Markdown.

## Inline Links

The most common way to create links in Markdown is using inline syntax:

[Visit Google](https://www.google.com)

[Link with title](https://www.example.com "Example Website")

## External Links

Links to external websites:

- [GitHub](https://github.com)
- [Stack Overflow](https://stackoverflow.com)
- [MDN Web Docs](https://developer.mozilla.org)

## Autolinks

URLs can automatically be turned into links using angle brackets:

<https://www.example.com>

<https://github.com/user/repository>

## Email Links

Email addresses can also be linked:

<user@example.com>

<support@company.com>

## Plain URLs

Sometimes URLs are written without special syntax:

Visit https://www.example.com for more information.

Go to http://localhost:3000 to see the application.

## www. Links

Links starting with www. are often recognized:

www.example.com

www.github.com

# Reference Style Links

Reference-style links keep your Markdown readable by separating link text from URLs.

## Basic Reference Links

[GitHub][github]

[Google][google]

[github]: https://github.com
[google]: https://www.google.com

## Collapsed Reference Links

Use the link text as both label and key:

[GitHub][]

[Stack Overflow][]

[GitHub]: https://github.com
[Stack Overflow]: https://stackoverflow.com

## Shortcut Reference Links

Omit the second pair of brackets entirely:

[GitHub]

[Google]

[GitHub]: https://github.com
[Google]: https://www.google.com

## Reference Links with Titles

[MDN Web Docs][mdn]

[Example Site][example]

[mdn]: https://developer.mozilla.org "Mozilla Developer Network"
[example]: https://www.example.com "An Example Website"

## Numbered References

For cleaner markup, you can use numbered references:

Visit [GitHub][1] or [Stack Overflow][2] for help.

Check out [MDN][3] for web documentation.

[1]: https://github.com
[2]: https://stackoverflow.com
[3]: https://developer.mozilla.org

## Best Practices

1. Keep reference definitions at the end of the document
2. Use descriptive reference names
3. Group related links together

# Markdown Image Links

Images in Markdown use a similar syntax to links but with an exclamation mark.

## Basic Image Syntax

![Alt text](https://via.placeholder.com/300x200)

## Image with Title

![Placeholder Image](https://via.placeholder.com/300x200 "Placeholder Title")

## Images from URLs

![Random Image](https://picsum.photos/400/300)

![Gravatar](https://www.gravatar.com/avatar/0)

## Local Images

![Logo](./images/logo.png)

![Screenshot](../assets/screenshots/dashboard.png)

## Relative Paths

Images can be referenced with relative paths:

![Header Image](/images/header.jpg)

![Icon](../icons/logo.svg)

![Thumbnail](./thumbnails/thumb.png)

## Image as Link

You can make an image clickable by wrapping it in a link:

[![Visit GitHub](https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png)](https://github.com)

## Images with Reference Style

![Placeholder][img1]

![Logo][logo]

[img1]: https://via.placeholder.com/300x200
[logo]: https://example.com/logo.png

## HTML Images

Sometimes you need more control, so you can use HTML:

<img src="image.jpg" alt="Description" width="300" height="200">

<img src="photo.png" alt="Photo" class="responsive-image">

# Mixed Link Content

This document demonstrates various link types used together in a real context.

## Quick Links

Here are some useful resources:

- Documentation: [Docs][docs]
- Support: [Email Support](mailto:support@example.com)
- Website: <https://www.example.com>

[docs]: https://docs.example.com

## Images and Media

Check out our logo:

![Company Logo](https://example.com/logo.png "Our Logo")

Or click the banner below:

[![Click to Visit](https://example.com/banner.jpg)](https://example.com)

## Code Repositories

Our code is hosted on:

- [GitHub Repository][github]
- [GitLab Mirror][gitlab]

[github]: https://github.com/company/project
[gitlab]: https://gitlab.com/company/project

## External Resources

Learn more from these sources:

1. [MDN Web Docs][1]
2. [Stack Overflow][2]
3. [W3C Standards][3]

[1]: https://developer.mozilla.org "Mozilla Developer Network"
[2]: https://stackoverflow.com
[3]: https://www.w3.org

## Contact Information

- Website: www.example.com
- Email: <contact@example.com>
- Blog: https://blog.example.com

## Navigation

- [Home](/)
- [About](/about)
- [Contact](#contact)

## Quick Access

Use these shortcuts:

- [Dashboard](./dashboard.md)
- [Settings](../settings.md)
- [API Reference](./api/v1/reference.md)

---

*Last updated: [January 2025][]*

[January 2025]: https://example.com/changelog/2025-01

# Broken Reference Links

This document contains intentional broken references for testing link validation tools.

## Undefined References

This link references [something][missing] that doesn't exist.

[This one][undefined] also has no definition.

[Another broken link][not-found] here.

## Collapsed Broken Links

[GitHub][] is missing its definition.

[Missing Link][] should trigger an error.

## Shortcut Broken Links

[GitHub] has no reference definition.

[Missing Link] should be detected as broken.

[Not Defined] will cause validation issues.

## Mixed Valid and Invalid

This [valid link][google] works fine.

But this [broken link][bad-ref] doesn't.

[Another valid one][github] is okay.

[Another broken][another-bad] is not.

[google]: https://www.google.com
[github]: https://github.com

## Typos in References

Sometimes reference names have typos:

[GitHub][gituhub]  // typo in reference
[Stack Overflow][stackoverlfow]  // misspelled

[gituhub]: https://github.com

## Case Sensitivity

Reference names can be case-sensitive in some implementations:

[GitHub][github]
[GitHub][GITHUB]  // might not match

[github]: https://github.com

## Purpose

This document helps test:
- Reference validation
- Error reporting
- Link checking tools
- Markdown linting

# Duplicate Links

This document contains the same URLs appearing multiple times.

## Repeated External Links

Visit [GitHub][1] for open source projects.

Check out [GitHub][1] for repositories.

More info at [GitHub][1].

[GitHub][1] is the platform.

[1]: https://github.com

## Inline Duplicates

The documentation is at [MDN][mdn].

Learn web development at [MDN][mdn].

Reference [MDN][mdn] for details.

[mdn]: https://developer.mozilla.org

## Multiple References to Same URL

[Google][google] is a search engine.

[Search][google] helps find information.

[Big G][google] provides many services.

[google]: https://www.google.com

## Duplicate Autolinks

Visit our site: <https://www.example.com>

More info: <https://www.example.com>

Homepage: <https://www.example.com>

## Duplicate Plain URLs

Go to https://www.example.com

See https://www.example.com for details

Visit https://www.example.com today

## Duplicate Images

![Logo](https://example.com/logo.png)

Our logo: ![Logo](https://example.com/logo.png)

Brand: ![Logo](https://example.com/logo.png)

## Use Cases

Testing duplicate detection for:
- SEO optimization
- Link consolidation
- Content analysis
- Statistics tracking

# Internal Documentation

This document demonstrates internal linking patterns.

## Table of Contents

- [Introduction](#introduction)
- [Getting Started](#getting-started)
- [API Reference](#api-reference)
- [Advanced Topics](#advanced-topics)

## Introduction

Welcome to the documentation. Use the navigation above to jump to sections.

## Getting Started

### Prerequisites

Before you begin, make sure you have:

- Node.js installed
- A text editor
- Basic command line knowledge

See [Installation Guide](./installation.md) for details.

### Project Structure

Our project is organized as follows:

- [src/](./src/) - Source code
- [tests/](./tests/) - Test files
- [docs/](./docs/) - Documentation

### Related Files

- [Configuration](./config.md)
- [Contributing](../CONTRIBUTING.md)
- [License](../LICENSE)

## API Reference

### Core Functions

The main API functions are documented here:

- [Users API](./api/users.md)
- [Auth API](./api/auth.md)
- [Data API](./api/data.md)

### Endpoints

Key endpoints:

- [GET /api/users](./api/endpoints.md#get-users)
- [POST /api/auth](./api/endpoints.md#post-auth)
- [PUT /api/data](./api/endpoints.md#put-data)

## Advanced Topics

### Configuration Files

See these configuration guides:

- [Production Config](../config/production.md)
- [Development Config](../config/development.md)
- [Test Config](../config/test.md)

### Deployment

Deployment documentation:

- [Docker Deployment](./deployment/docker.md)
- [Kubernetes Deployment](./deployment/k8s.md)
- [Cloud Deployment](./deployment/cloud.md)

## Troubleshooting

Common issues:

- [Connection Issues](./troubleshooting/connection.md)
- [Authentication Errors](./troubleshooting/auth.md)
- [Performance Problems](./troubleshooting/performance.md)

## FAQ

Frequently asked questions are answered in our [FAQ](./faq.md).

## Getting Help

- [Support Forum](https://forum.example.com)
- [Issue Tracker](https://github.com/example/issues)
- [Community Chat](https://discord.gg/example)

## Appendix

- [Glossary](./glossary.md)
- [Changelog](./changelog.md)
- [Migration Guide](./migration.md)

---

[Back to Top](#internal-documentation)
[Return Home](../README.md)

# API Technical Documentation

Complete reference for the Example API v2.0.

## Table of Contents

1. [Overview][overview]
2. [Authentication][auth]
3. [Endpoints][endpoints]
4. [Models][models]
5. [Error Handling][errors]
6. [Rate Limiting][rate-limit]

## Overview

The Example API provides RESTful access to [Example Service][service].

**Base URL:** `https://api.example.com/v2`

**Documentation Version:** 2.0.1

### Key Features

- JSON-based request/response format
- JWT-based authentication
- Comprehensive error handling
- Automatic rate limiting

### Related Documentation

- [Quick Start Guide][quickstart]
- [SDK Reference][sdk]
- [Migration Guide][migration]

## Authentication

All API requests require authentication using JWT tokens.

### Getting a Token

```bash
POST /auth/token
Content-Type: application/json

{
  "username": "[email protected]",
  "password": "your-password"
}
```

Response:

```json
{
  "token": "eyJhbGciOiJIUzI1NiIs...",
  "expires_in": 3600
}
```

### Using the Token

Include the token in the Authorization header:

```http
Authorization: Bearer YOUR_TOKEN
```

### Token Management

- [Refresh Token][refresh]
- [Revoke Token][revoke]
- [Token Validation][validate]

## Endpoints

### User Management

#### Create User

```http
POST /users
Authorization: Bearer {token}
Content-Type: application/json
```

[See detailed docs][create-user]

#### Get User

```http
GET /users/{id}
Authorization: Bearer {token}
```

[See detailed docs][get-user]

#### List Users

```http
GET /users?page=1&limit=10
Authorization: Bearer {token}
```

[See detailed docs][list-users]

#### Update User

```http
PUT /users/{id}
Authorization: Bearer {token}
Content-Type: application/json
```

[See detailed docs][update-user]

#### Delete User

```http
DELETE /users/{id}
Authorization: Bearer {token}
```

[See detailed docs][delete-user]

### Data Operations

#### Create Record

[Create Record Endpoint][create-record]

#### Query Records

[Query Records Endpoint][query-records]

#### Update Record

[Update Record Endpoint][update-record]

#### Delete Record

[Delete Record Endpoint][delete-record]

## Models

### User Object

```json
{
  "id": "string",
  "email": "string",
  "name": "string",
  "created_at": "datetime",
  "updated_at": "datetime"
}
```

[Full User Model][user-model]

### Record Object

[Full Record Model][record-model]

### Error Response

[Error Response Format][error-format]

## Error Handling

### HTTP Status Codes

- `200` - Success
- `201` - Created
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found
- `500` - Server Error

### Error Response

```json
{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human readable message",
    "details": {}
  }
}
```

[See all error codes][error-codes]

## Rate Limiting

### Limits

- Free tier: 100 requests/hour
- Pro tier: 1000 requests/hour
- Enterprise: Unlimited

### Headers

`X-RateLimit-Limit` - Request limit
`X-RateLimit-Remaining` - Remaining requests
`X-RateLimit-Reset` - Reset timestamp

[Rate Limit Details][rate-limits]

## SDKs and Libraries

Official SDKs:

- [JavaScript SDK][js-sdk]
- [Python SDK][py-sdk]
- [Go SDK][go-sdk]
- [Java SDK][java-sdk]

## Support

- [Documentation][docs]
- [Community Forum][forum]
- [Issue Tracker][issues]
- [Email Support][email]

---

[overview]: #overview
[auth]: #authentication
[endpoints]: #endpoints
[models]: #models
[errors]: #error-handling
[rate-limit]: #rate-limiting

[service]: https://example.com
[quickstart]: ./quickstart.md
[sdk]: ./sdk.md
[migration]: ./migration-v1-to-v2.md

[refresh]: ./auth/refresh-token.md
[revoke]: ./auth/revoke-token.md
[validate]: ./auth/validate-token.md

[create-user]: ./endpoints/users/create.md
[get-user]: ./endpoints/users/get.md
[list-users]: ./endpoints/users/list.md
[update-user]: ./endpoints/users/update.md
[delete-user]: ./endpoints/users/delete.md

[create-record]: ./endpoints/data/create.md
[query-records]: ./endpoints/data/query.md
[update-record]: ./endpoints/data/update.md
[delete-record]: ./endpoints/data/delete.md

[user-model]: ./models/user.md
[record-model]: ./models/record.md
[error-format]: ./models/error.md

[error-codes]: ./errors/codes.md
[rate-limits]: ./rate-limits.md

[js-sdk]: https://github.com/example/js-sdk
[py-sdk]: https://github.com/example/py-sdk
[go-sdk]: https://github.com/example/go-sdk
[java-sdk]: https://github.com/example/java-sdk

[docs]: https://docs.example.com
[forum]: https://forum.example.com
[issues]: https://github.com/example/issues
[email]: mailto:support@example.com

# Getting Started with Web Development in 2025

So you want to become a web developer? You're in the right place! This guide will help you navigate the exciting world of web development.

## Why Web Development?

Web development is one of the most [in-demand skills][1] today. With remote work becoming the norm, there's never been a better time to learn.

## The Foundation: HTML, CSS, and JavaScript

Every web developer starts with the three pillars:

### HTML - Structure

HTML provides the structure of your web pages. Learn the basics at [MDN Web Docs][mdn-html].

### CSS - Styling

CSS makes your pages beautiful. Check out [CSS Tricks][css-tricks] for amazing tips.

### JavaScript - Interactivity

JavaScript brings your pages to life. Start with [JavaScript.info][js-info].

## Choosing Your Framework

Once you master the basics, choose a framework:

- [React][react] - Most popular, great ecosystem
- [Vue][vue] - Easy to learn, gentle curve
- [Angular][angular] - Enterprise-grade, opinionated
- [Svelte][svelte] - Compile-time, blazing fast

## Learning Resources

Here are my favorite resources:

### Free Resources

- [freeCodeCamp][freecodecamp]
- [The Odin Project][odin]
- [JavaScript30][js30]

### Paid Courses

- [Udemy][udemy]
- [Pluralsight][pluralsight]
- [Frontend Masters][frontend-masters]

## Building Projects

Theory is great, but practice is better. Start with these project ideas:

1. **Personal Portfolio** - Showcase your work
2. **Todo App** - Learn state management
3. **Weather App** - Work with APIs
4. [More project ideas][projects]

## Version Control with Git

Every developer needs Git. Learn it at:

- [Git SCM][git-scm]
- [GitHub Skills][github-skills]
- [Git Tower Guide][git-tower]

## Deployment

Make your work live! Try these platforms:

- [Vercel][vercel] - Best for frontend
- [Netlify][netlify] - Great free tier
- [Heroku][heroku] - Full-stack apps

## Join the Community

Web development has an amazing community:

- [Dev.to][dev] - Blog platform
- [Stack Overflow][stackoverflow] - Q&A
- [Reddit r/webdev][reddit] - Discussions
- [Discord servers][discord]

## Stay Updated

Follow these newsletters:

- [JavaScript Weekly][js-weekly]
- [CSS-Tricks Newsletter][css-newsletter]
- [Frontend Focus][frontend-focus]

## Tools of the Trade

### Code Editors

- [VS Code][vscode] - Most popular
- [WebStorm][webstorm] - Powerful IDE
- [Sublime Text][sublime] - Lightning fast

### Browser DevTools

Master the [Chrome DevTools][chrome-devtools] - they're essential!

## My Learning Path

Here's the path I recommend:

1. Start with HTML/CSS (2-3 weeks)
2. Learn JavaScript basics (4-6 weeks)
3. Build small projects (ongoing)
4. Pick a framework (2-4 weeks)
5. Learn Git and GitHub (1 week)
6. Deploy your first project (1 week)
7. Never stop learning! 🎓

## Common Mistakes to Avoid

1. **Tutorial Hell** - Don't just watch, BUILD!
2. **Imposter Syndrome** - Everyone feels it
3. **Comparing Yourself** - Focus on your journey
4. [Read more][mistakes]

## Success Stories

Need motivation? Read these:

- [Self-taught developer lands job at Google][story1]
- [Career switch from teacher to developer][story2]
- [How I learned to code in 6 months][story3]

## Next Steps

Ready to start? Here's your action plan:

- [ ] Set up your development environment
- [ ] Complete your first HTML page
- [ ] Write your first JavaScript function
- [ ] Create a GitHub account
- [ ] Build your first project

## Final Thoughts

Web development is a journey, not a destination. Enjoy the process, embrace the challenges, and never stop learning.

> "The only way to learn a new programming language is by writing programs in it." - Dennis Ritchie

Happy coding! 🚀

---

**Found this helpful?** Share it with others who are starting their journey!

[Follow me on Twitter][twitter] for more tips and resources.

[1]: https://www.indeed.com/career-advice/finding-a-job/in-demand-skills
[mdn-html]: https://developer.mozilla.org/en-US/docs/Web/HTML
[css-tricks]: https://css-tricks.com
[js-info]: https://javascript.info

[react]: https://reactjs.org
[vue]: https://vuejs.org
[angular]: https://angular.io
[svelte]: https://svelte.dev

[freecodecamp]: https://www.freecodecamp.org
[odin]: https://www.theodinproject.com
[js30]: https://javascript30.com

[udemy]: https://www.udemy.com
[pluralsight]: https://www.pluralsight.com
[frontend-masters]: https://frontendmasters.com

[projects]: https://github.com/florinpop17/30-seconds-of-code

[git-scm]: https://git-scm.com/doc
[github-skills]: https://skills.github.com
[git-tower]: https://www.git-tower.com/learn

[vercel]: https://vercel.com
[netlify]: https://netlify.com
[heroku]: https://heroku.com

[dev]: https://dev.to
[stackoverflow]: https://stackoverflow.com
[reddit]: https://reddit.com/r/webdev
[discord]: https://discord.gg/webdev

[js-weekly]: https://javascriptweekly.com
[css-newsletter]: https://css-tricks.com/newsletter
[frontend-focus]: https://frontendfoc.us

[vscode]: https://code.visualstudio.com
[webstorm]: https://jetbrains.com/webstorm
[sublime]: https://sublimetext.com

[chrome-devtools]: https://developer.chrome.com/docs/devtools

[mistakes]: https://www.freecodecamp.org/news/mistakes-to-avoid-as-a-web-development-beginner

[story1]: https://medium.com/@nemo2013/becoming-a-google-engineer-without-a-cs-degree-93dd5ac45a2c
[story2]: https://www.freecodecamp.org/news/how-i-got-a-developer-job-without-a-degree
[story3]: https://www.codecademy.com/resources/blog/how-i-learned-to-code-in-6-months/

[twitter]: https://twitter.com/yourhandle

# REST API Documentation

Complete API reference for the MyApp REST API.

## Base URL

```
https://api.myapp.com/v1
```

## Authentication

All API requests require authentication using API keys.

### Getting an API Key

1. Sign up at [https://myapp.com/signup][signup]
2. Navigate to Settings > API Keys
3. Generate a new key

### Using the API Key

Include the key in the request header:

```http
X-API-Key: your-api-key-here
```

Or as a query parameter:

```http
https://api.myapp.com/v1/users?api_key=your-api-key-here
```

See [Authentication Guide][auth-guide] for more details.

## Endpoints

### Users

#### Create User

Create a new user account.

```http
POST /v1/users
Content-Type: application/json
X-API-Key: your-api-key

{
  "email": "[email protected]",
  "password": "securePassword123",
  "name": "John Doe"
}
```

**Response:**

```json
{
  "id": "usr_1234567890",
  "email": "[email protected]",
  "name": "John Doe",
  "created_at": "2025-01-17T10:00:00Z"
}
```

[See full documentation][create-user-doc]

#### Get User

Retrieve user details.

```http
GET /v1/users/{user_id}
X-API-Key: your-api-key
```

**Response:**

```json
{
  "id": "usr_1234567890",
  "email": "[email protected]",
  "name": "John Doe",
  "created_at": "2025-01-17T10:00:00Z",
  "updated_at": "2025-01-17T12:00:00Z"
}
```

[See full documentation][get-user-doc]

#### List Users

Get a paginated list of users.

```http
GET /v1/users?page=1&limit=20&sort=name:asc
X-API-Key: your-api-key
```

**Query Parameters:**

- `page` (integer) - Page number (default: 1)
- `limit` (integer) - Items per page (default: 20, max: 100)
- `sort` (string) - Sort field and direction (format: `field:direction`)

**Response:**

```json
{
  "data": [
    {
      "id": "usr_1234567890",
      "email": "[email protected]",
      "name": "John Doe"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 100,
    "pages": 5
  }
}
```

[See full documentation][list-users-doc]

#### Update User

Update user information.

```http
PUT /v1/users/{user_id}
Content-Type: application/json
X-API-Key: your-api-key

{
  "name": "Jane Doe"
}
```

[See full documentation][update-user-doc]

#### Delete User

Delete a user account.

```http
DELETE /v1/users/{user_id}
X-API-Key: your-api-key
```

[See full documentation][delete-user-doc]

### Authentication

#### Login

Authenticate a user and receive a session token.

```http
POST /v1/auth/login
Content-Type: application/json

{
  "email": "[email protected]",
  "password": "securePassword123"
}
```

**Response:**

```json
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expires_at": "2025-01-18T10:00:00Z",
  "user": {
    "id": "usr_1234567890",
    "email": "[email protected]",
    "name": "John Doe"
  }
}
```

[See full documentation][login-doc]

#### Logout

Invalidate the current session token.

```http
POST /v1/auth/logout
Authorization: Bearer {token}
```

[See full documentation][logout-doc]

#### Refresh Token

Refresh an expired session token.

```http
POST /v1/auth/refresh
Authorization: Bearer {expired_token}
```

[See full documentation][refresh-doc]

### Data

#### Create Record

Create a new data record.

```http
POST /v1/data
Content-Type: application/json
Authorization: Bearer {token}

{
  "title": "My Record",
  "content": "Record content here",
  "metadata": {
    "key": "value"
  }
}
```

[See full documentation][create-record-doc]

#### Get Record

Retrieve a specific record.

```http
GET /v1/data/{record_id}
Authorization: Bearer {token}
```

[See full documentation][get-record-doc]

#### Query Records

Search and filter records.

```http
GET /v1/data?query=keyword&filter[field]=value&sort=created_at:desc
Authorization: Bearer {token}
```

[See full documentation][query-records-doc]

## Code Examples

### JavaScript/Node.js

```javascript
const axios = require('axios');

const client = axios.create({
  baseURL: 'https://api.myapp.com/v1',
  headers: {
    'X-API-Key': 'your-api-key'
  }
});

// Create user
async function createUser(userData) {
  try {
    const response = await client.post('/users', userData);
    return response.data;
  } catch (error) {
    console.error('Error creating user:', error.response.data);
    throw error;
  }
}

// Get user
async function getUser(userId) {
  const response = await client.get(`/users/${userId}`);
  return response.data;
}

// List users
async function listUsers(params = {}) {
  const response = await client.get('/users', { params });
  return response.data;
}
```

[See more JavaScript examples][js-examples]

### Python

```python
import requests

class MyAppClient:
    def __init__(self, api_key):
        self.base_url = 'https://api.myapp.com/v1'
        self.headers = {'X-API-Key': api_key}

    def create_user(self, email, password, name):
        url = f'{self.base_url}/users'
        data = {
            'email': email,
            'password': password,
            'name': name
        }
        response = requests.post(url, json=data, headers=self.headers)
        response.raise_for_status()
        return response.json()

    def get_user(self, user_id):
        url = f'{self.base_url}/users/{user_id}'
        response = requests.get(url, headers=self.headers)
        response.raise_for_status()
        return response.json()

    def list_users(self, page=1, limit=20):
        url = f'{self.base_url}/users'
        params = {'page': page, 'limit': limit}
        response = requests.get(url, headers=self.headers, params=params)
        response.raise_for_status()
        return response.json()
```

[See more Python examples][python-examples]

### cURL

```bash
# Create user
curl -X POST https://api.myapp.com/v1/users \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your-api-key" \
  -d '{
    "email": "[email protected]",
    "password": "securePassword123",
    "name": "John Doe"
  }'

# Get user
curl -X GET https://api.myapp.com/v1/users/usr_1234567890 \
  -H "X-API-Key: your-api-key"

# List users
curl -X GET "https://api.myapp.com/v1/users?page=1&limit=20" \
  -H "X-API-Key: your-api-key"
```

[See more cURL examples][curl-examples]

## Error Handling

### Error Response Format

All errors follow this format:

```json
{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human readable error message",
    "details": {
      "field": "Additional error details"
    }
  }
}
```

### Common Error Codes

- `INVALID_API_KEY` - The provided API key is invalid
- `RATE_LIMIT_EXCEEDED` - API rate limit has been exceeded
- `INVALID_REQUEST` - The request is malformed
- `UNAUTHORIZED` - Authentication is required
- `NOT_FOUND` - The requested resource was not found
- `SERVER_ERROR` - An internal server error occurred

[See all error codes][error-codes]

## Rate Limiting

API requests are rate limited based on your subscription plan:

- **Free**: 100 requests/hour
- **Pro**: 1,000 requests/hour
- **Enterprise**: Unlimited

Rate limit headers are included in every response:

```http
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1642425600
```

[See rate limiting details][rate-limits]

## Webhooks

Configure webhooks to receive real-time notifications.

### Creating a Webhook

```http
POST /v1/webhooks
Content-Type: application/json
Authorization: Bearer {token}

{
  "url": "https://yourapp.com/webhooks",
  "events": ["user.created", "user.updated"]
}
```

### Webhook Events

- `user.created` - A new user was created
- `user.updated` - A user was updated
- `user.deleted` - A user was deleted
- `data.created` - A new record was created
- `data.updated` - A record was updated

[See webhook documentation][webhooks-doc]

## SDKs and Libraries

Official SDKs:

- [JavaScript SDK][js-sdk] - npm: `@myapp/sdk`
- [Python SDK][python-sdk] - pip: `myapp-sdk`
- [Go SDK][go-sdk] - go: `github.com/myapp/go-sdk`
- [Ruby SDK][ruby-sdk] - gem: `myapp-sdk`

## Changelog

### Version 1.2.0 (2025-01-15)

- Added webhook support
- Improved error messages
- Fixed pagination bug

### Version 1.1.0 (2024-12-01)

- Added data endpoints
- Improved rate limiting
- Added Python SDK

### Version 1.0.0 (2024-11-01)

- Initial release

[View full changelog][changelog]

## Support

- **Documentation**: [https://docs.myapp.com][docs]
- **Status Page**: [https://status.myapp.com][status]
- **Support Email**: [support@myapp.com][support-email]
- **GitHub Issues**: [https://github.com/myapp/api/issues][github-issues]
- **Community Forum**: [https://forum.myapp.com][forum]

---

**Need help?** Contact our [support team][support-email] or join our [community forum][forum].

[signup]: https://myapp.com/signup
[auth-guide]: ./authentication.md

[create-user-doc]: ./endpoints/users/create.md
[get-user-doc]: ./endpoints/users/get.md
[list-users-doc]: ./endpoints/users/list.md
[update-user-doc]: ./endpoints/users/update.md
[delete-user-doc]: ./endpoints/users/delete.md

[login-doc]: ./endpoints/auth/login.md
[logout-doc]: ./endpoints/auth/logout.md
[refresh-doc]: ./endpoints/auth/refresh.md

[create-record-doc]: ./endpoints/data/create.md
[get-record-doc]: ./endpoints/data/get.md
[query-records-doc]: ./endpoints/data/query.md

[js-examples]: ./examples/javascript.md
[python-examples]: ./examples/python.md
[curl-examples]: ./examples/curl.md

[error-codes]: ./errors/codes.md
[rate-limits]: ./rate-limits.md
[webhooks-doc]: ./webhooks.md

[js-sdk]: https://github.com/myapp/js-sdk
[python-sdk]: https://github.com/myapp/python-sdk
[go-sdk]: https://github.com/myapp/go-sdk
[ruby-sdk]: https://github.com/myapp/ruby-sdk

[changelog]: ./changelog.md

[docs]: https://docs.myapp.com
[status]: https://status.myapp.com
[support-email]: mailto:support@myapp.com
[github-issues]: https://github.com/myapp/api/issues
[forum]: https://forum.myapp.com