@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Pirates API
@base https://api.fungenerators.com
@version 1.5
@auth ApiKey X-Fungenerators-Api-Secret in header
@endpoints 4
@toc pirate(4)

@endpoint GET /pirate/generate/name
@desc Generate random pirate names.
@optional {variation: str(string) # Variation to generate `male/female`., limit: int(integer) # No of names to generate}
@returns(200) 200  response
@errors {401: 401  response}

@endpoint GET /pirate/generate/insult
@desc Generate random pirate insults.
@optional {limit: int(integer) # No of insults to generate}
@returns(200) 200  response
@errors {401: 401  response}

@endpoint GET /pirate/generate/lorem-ipsum
@desc Generate pirate lorem ipsum.
@optional {type: str(string) # Type of element to generate `paragraphs/sentences/words`., limit: int(integer) # No of elements to generate}
@returns(200) 200  response
@errors {401: 401  response}

@endpoint GET /pirate/translate
@desc Translate from English to pirate.
@required {text: str(string) # Text to translate to pirate lingo.}
@returns(200) 200  response
@errors {401: 401  response}

@end