|
@@ -1,10 +1,10 @@
|
|
|
# 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).
|
|
|
|
|
|
-Here's some of the information you can customise:
|
|
|
-- [General API information](documenting-api-information.html)
|
|
|
-- [Endpoint metadata](documenting-endpoint-metadata.html) (endpoint group, title, description, authentication status)
|
|
|
-- [Headers to be sent in requests to the endpoint](documenting-endpoint-headers.html)
|
|
|
-- [Query parameters and URL parameters to be sent in requests to the endpoint](documenting-endpoint-query-parameters.html)
|
|
|
-- [Body parameters and files to be sent in requests to the endpoint](documenting-endpoint-body-parameters.html)
|
|
|
-- [Example responses returned from the endpoint](documenting-endpoint-responses.html)
|
|
|
+## Contents
|
|
|
+- [General API information](documenting-api-information.md)
|
|
|
+- [Endpoint metadata](documenting-endpoint-metadata.md) (endpoint group, title, description, authentication status)
|
|
|
+- [Headers to be sent in requests to the endpoint](documenting-endpoint-headers.md)
|
|
|
+- [Query parameters and URL parameters to be sent in requests to the endpoint](documenting-endpoint-query-parameters.md)
|
|
|
+- [Body parameters and files to be sent in requests to the endpoint](documenting-endpoint-body-parameters.md)
|
|
|
+- [Example responses returned from the endpoint](documenting-endpoint-responses.md)
|