Mirrors/gotosocial
1
0
Fork 0
mirror of https://github.com/superseriousbusiness/gotosocial.git synced 2024-11-01 06:50:00 +00:00
Code Issues Projects Releases Packages Wiki Activity
gotosocial/docs/api/swagger.md
Mia Heidenstedt c0a2d702a3
[docs] Update swagger.md (#933) 
See https://github.com/superseriousbusiness/gotosocial/blob/main/internal/api/security/security.go

```go
	s.AttachMiddleware(m.RateLimit(RateLimitOptions{
		// accept a maximum of 1000 requests in 5 minutes window
		Period: 5 * time.Minute,
		Limit:  1000,
	}))
```
2022-10-31 13:20:39 +01:00

1.2 KiB
Raw Blame History

API Documentation

Rate limit

To prevent abuse of the API an IP-based HTTP rate limit is in place, a maximum of 1000 requests in a 5 minutes time window are allowed, every response will include the current status of the rate limit with the following headers:

  • x-ratelimit-limit maximum number of requests allowed per time period (fixed)
  • x-ratelimit-remaining number of remaining requests that can still be performed
  • x-ratelimit-reset unix timestamp when the rate limit will reset

In case the rate limit is exceeded an HTTP 429 error is returned to the caller.

GoToSocial uses go-swagger to generate a V2 OpenAPI specification document from code annotations.

The resulting API documentation is rendered below, for quick reference.

If you'd like to do more with the spec, you can also view the swagger.yaml directly, and then paste it into something like the Swagger Editor in order to autogenerate GoToSocial API clients in different languages, convert the doc to JSON or OpenAPI v3 specification, etc. See here for more.

!!swagger swagger.yaml!!