Skip to content

Removing dead links #795

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 12, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/getting-started/generating-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The base URL used in the Postman collection will be the value of the `base_url`
## Manually modifying the content of the generated documentation
If you want to modify the content of your generated documentation without changing the routes, go ahead and edit the generated `index.md` file.

This file is located in the `source` folder of your `output` directory (see [configuration](config.html#output)), so by default, this is `public/docs/source/index.md`.
This file is located in the `source` folder of your `output` directory (see configuration), so by default, this is `public/docs/source/index.md`.

After editing the markdown file, you can use the `apidoc:rebuild` command to rebuild your documentation into HTML.

Expand All @@ -40,7 +40,7 @@ php artisan apidoc:rebuild
The contents of `prepend.md` will be added after the front matter and info text, while the contents of `append.md` will be added at the end of the document.

## Specifying language for examples
For each endpoint, an example request is shown in [each language configured](config.html#example-languages). To add a language which is not supported by this package, you'll have to create your own view for how an example should render. Here's how:
For each endpoint, an example request is shown in each language configured. To add a language which is not supported by this package, you'll have to create your own view for how an example should render. Here's how:

- Publish the vendor views by running:

Expand All @@ -54,8 +54,8 @@ php artisan apidoc:rebuild
- `methods`: an array of the HTTP methods for that route
- `boundUri`: the complete URL for the route, with any url parameters replaced (/users/{id} -> /users/1)
- `headers`: key-value array of headers to be sent with route (according to your configuration)
- `cleanQueryParameters`: key-value array of query parameters with example values to be sent with the request. Parameters which have been excluded from the example requests (see [Example Parameters](documenting.html#example-parameters)) will not be present here.
- `cleanBodyParameters`: key-value array of body parameters with example values to be sent with the request. Parameters which have been excluded from the example requests (see [Example Parameters](documenting.html#example-parameters)) will not be present here.
- `cleanQueryParameters`: key-value array of query parameters with example values to be sent with the request. Parameters which have been excluded from the example requests (see Example Parameters at Documenting your API) will not be present here.
- `cleanBodyParameters`: key-value array of body parameters with example values to be sent with the request. Parameters which have been excluded from the example requests (see Example Parameters at Documenting your API will not be present here.

- Add the language to the `example_languages` array in the package config.

Expand Down
4 changes: 2 additions & 2 deletions docs/under-the-hood/how-it-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ order: 2
After installing this package and running the command `php artisan apidoc:generate` in your application, here's what happens:

- The package fetches all your application's routes.
- It looks through your [configuration file](config.md) to filter the routes to the ones you actually want to document. For each route, it retrieves the settings you want to apply to it, if any.
- It looks through your configuration file to filter the routes to the ones you actually want to document. For each route, it retrieves the settings you want to apply to it, if any.
- It processes each route. "Process" here involves using a number of strategies to extract the route's information: group, title, description, body parameters, query parameters, and a sample response, if possible.
- After processing the routes, it generates a markdown file describing the routes from the parsed data and passes them to [Documentarian](https://github.com/mpociot/documentarian), which wraps them in a theme and converts them into HTML and CSS.
- It generates a Postman API collection for your routes. ([This can be disabled.](config.html#postman))
- It generates a Postman API collection for your routes. This can be disabled.