Hands-On RESTful API Design Patterns and Best Practices
上QQ阅读APP看书,第一时间看更新

Conventions used

There are a number of text conventions used throughout this book.

CodeInText: Indicates code words in text, database table names, folder names, filenames, file extensions, pathnames, dummy URLs, user input, and Twitter handles. Here is an example: "The four basic HTTP operations: GET, POST, PUT, and DELETE."

A block of code is set as follows:

@GetMapping({"/v1/investors","/v1.1/investors","/v2/investors"})
public List<Investor> fetchAllInvestors()
{
return investorService.fetchAllInvestors();
}

When we wish to draw your attention to a particular part of a code block, the relevant lines or items are set in bold:

public interface DeleteServiceFacade {
boolean deleteAStock(String investorId, String stockTobeDeletedSymbol);
boolean deleteStocksInBulk(String investorId, List<String> stocksSymbolsList);
}

Any command-line input or output is written as follows:

$ mkdir css
$ cd css

Bold: Indicates a new term, an important word, or words that you see onscreen. For example, words in menus or dialog boxes appear in the text like this. Here is an example: "The Pipeline entity is entirely responsible for orchestrating control and data flows"

Warnings or important notes appear like this.
Tips and tricks appear like this.