Documenting your API

Scribe tries to infer information about your API from your code, but you can enrich this information in the config and by using annotations (tags in doc block comments).

• Adding general information about your API
  • Authentication information
  • Introductory text
  • Title
  • Logo
• Specifying metadata about an endpoint
  • Endpoint title and description
  • Grouping endpoints
  • Indicating authentication status
• Documenting headers for endpoints
• Documenting query and URL parameters for an endpoint
  • Specifying query parameters
  • Specifying example values
  • Describing URL parameters
• Documenting body and file parameters for an endpoint
  • The manual way: Specifying body parameters with @bodyParam
  • Using FormRequests
  • Documenting file uploads
• Documenting responses from an endpoint
  • @response
  • @responseFile
  • Generating responses automatically via response calls
  • @apiResource, @apiResourceCollection, and @apiResourceModel
  • @transformer, @transformerCollection, and @transformerModel
  • How model instances are generated
  • Adding descriptions for fields in the responses

Excluding endpoints from the documentation

You can exclude endpoints from the documentation by using the @hideFromAPIDocumentation tag in the method or class doc block. Scribe will not extract any information about the route or add it to the generated docs.