How to use Google ReCaptcha as "security"
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 6
- Forks
- 3
- Avg merge
- 1h 54m
- Merged PRs (30d)
- 1
Description
Hi,
I have a path and have to secure it with either an API key or for browser clients with Google ReCaptcha, where the client recaptcha token is used within the request payload.
Payload
{
"g-recaptcha-response": "recaptcha client token which has to be verified",
// other payload data
}
OpenAPI YAML
openapi: 3.0.0
info:
title: Test
description: API
version: 1.0.0
components:
securitySchemes:
ApiKey:
type: apiKey
name: X-Api-Key
in: header
paths:
/a/b/c:
post:
description: ABC
security:
- ApiKey: []
- GoogleRecaptcha: [] # <--- how?!
responses:
"200":
description: success
content:
application/json:
example:
status: ok
How do I define the security scheme for GoogleRecaptcha?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the OpenAPI 3.0 securitySchemes and the /a/b/c example shown in the issue. Check how the specification models token-based security and whether the g-recaptcha-response payload can be represented; done means providing a clear, specification-aligned explanation or example for this use case.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, security
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100