appendix B Installing API linting and OpenAPI diff tools
This appendix guides you through installing the tools you need to run the examples in this book. To test your setup of the tools, check out the book’s code repository at https://github.com/apiopsbook/apiops.
You can follow the instructions in this appendix to set up the tools you need on your machine. But if you’re familiar with Docker, I also provide a Docker image with all the command-line tools installed in it. (You still need to follow the instructions for setting up the non–command-line interface [CLI] tools such as Visual Studio Code [VS Code], GitHub Copilot, and Anthropic Claude.) You can create the Docker container and attach to its terminal by running the following scripts:
git clone https://github.com/apiopsbook/apiops cd apiops ./2_create_apiops_container.sh ./3_attach_to_apiops_container.sh
This attaches you to the container terminal, and you can access the book source files on your host machine by switching to the books-source folder as follows:
root@apiops-host:/# root@apiops-host:/# cd book-source/ root@apiops-host:/book-source# ls -l
You can detach from the container terminal by using the exit command. But if you want to install the command-line tools on your computer, proceed with the instructions given next.