├── .gitattributes ├── .gitignore ├── ExampleHTTPCodes ├── http-Status-Codes-IETF.txt ├── http-Status-Codes-w3.txt └── http-Status-Codes.txt ├── REACT-TODO-APP-for-SwaggerAPI ├── .gitignore ├── README.md ├── app │ ├── App.js │ ├── components │ │ ├── Home.js │ │ ├── Main.js │ │ ├── Todo.js │ │ └── Todos │ │ │ ├── AddTodo.js │ │ │ ├── AllTodos.js │ │ │ ├── NewTodo.js │ │ │ └── SingleTodo.js │ └── config │ │ └── routes.js ├── package.json ├── public │ ├── bundle.js │ └── index.html └── webpack.config.js ├── ReadMe.md ├── TODO-API-for-swagger-genereated-node-apis-server ├── .gitignore ├── README.md ├── jmeterTest.jmx └── todo-api │ ├── .gitignore │ ├── README.md │ ├── api │ ├── controllers │ │ ├── AddTodo.js │ │ ├── DeleteTodoById.js │ │ ├── FindTodoById.js │ │ ├── GetAllTodos.js │ │ ├── README.md │ │ ├── UpdateTodoById.js │ │ └── hello_world.js │ ├── helpers │ │ ├── README.md │ │ ├── es.js │ │ └── monitor.js │ ├── mocks │ │ ├── GetAllTodos.js │ │ └── README.md │ └── swagger │ │ └── swagger.yaml │ ├── app.js │ ├── config │ ├── README.md │ └── default.yaml │ ├── package.json │ └── test │ └── api │ ├── controllers │ ├── README.md │ └── hello_world.js │ └── helpers │ └── README.md └── docker-ElasticSearch ├── ReadMe.md └── docker-compose.yml /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | 4 | # Custom for Visual Studio 5 | *.cs diff=csharp 6 | 7 | # Standard to msysgit 8 | *.doc diff=astextplain 9 | *.DOC diff=astextplain 10 | *.docx diff=astextplain 11 | *.DOCX diff=astextplain 12 | *.dot diff=astextplain 13 | *.DOT diff=astextplain 14 | *.pdf diff=astextplain 15 | *.PDF diff=astextplain 16 | *.rtf diff=astextplain 17 | *.RTF diff=astextplain 18 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Windows image file caches 2 | Thumbs.db 3 | ehthumbs.db 4 | 5 | # Folder config file 6 | Desktop.ini 7 | 8 | # Recycle Bin used on file shares 9 | $RECYCLE.BIN/ 10 | 11 | # Windows Installer files 12 | *.cab 13 | *.msi 14 | *.msm 15 | *.msp 16 | 17 | # Windows shortcuts 18 | *.lnk 19 | 20 | # ========================= 21 | # Operating System Files 22 | # ========================= 23 | 24 | # OSX 25 | # ========================= 26 | 27 | .DS_Store 28 | .AppleDouble 29 | .LSOverride 30 | 31 | # Thumbnails 32 | ._* 33 | 34 | # Files that might appear in the root of a volume 35 | .DocumentRevisions-V100 36 | .fseventsd 37 | .Spotlight-V100 38 | .TemporaryItems 39 | .Trashes 40 | .VolumeIcon.icns 41 | 42 | # Directories potentially created on remote AFP share 43 | .AppleDB 44 | .AppleDesktop 45 | Network Trash Folder 46 | Temporary Items 47 | .apdisk 48 | -------------------------------------------------------------------------------- /ExampleHTTPCodes/http-Status-Codes-IETF.txt: -------------------------------------------------------------------------------- 1 | Hypertext Transfer Protocol (HTTP) Status Code Registry 2 | 3 | Last Updated 4 | 2016-03-01 5 | 6 | Available Formats 7 | [IMG] 8 | XML [IMG] 9 | HTML [IMG] 10 | Plain text 11 | 12 | Registry included below 13 | 14 | * HTTP Status Codes 15 | 16 | HTTP Status Codes 17 | 18 | Registration Procedure(s) 19 | 20 | IETF Review 21 | 22 | Reference 23 | [RFC7231] 24 | 25 | Note 26 | 27 | 1xx: Informational - Request received, continuing process 28 | 2xx: Success - The action was successfully received, understood, and accepted 29 | 3xx: Redirection - Further action must be taken in order to complete the request 30 | 4xx: Client Error - The request contains bad syntax or cannot be fulfilled 31 | 5xx: Server Error - The server failed to fulfill an apparently valid request 32 | 33 | 34 | Available Formats 35 | [IMG] 36 | CSV 37 | 38 | Value Description Reference 39 | 100 Continue [RFC7231, Section 6.2.1] 40 | 101 Switching Protocols [RFC7231, Section 6.2.2] 41 | 102 Processing [RFC2518] 42 | 103-199 Unassigned 43 | 200 OK [RFC7231, Section 6.3.1] 44 | 201 Created [RFC7231, Section 6.3.2] 45 | 202 Accepted [RFC7231, Section 6.3.3] 46 | 203 Non-Authoritative Information [RFC7231, Section 6.3.4] 47 | 204 No Content [RFC7231, Section 6.3.5] 48 | 205 Reset Content [RFC7231, Section 6.3.6] 49 | 206 Partial Content [RFC7233, Section 4.1] 50 | 207 Multi-Status [RFC4918] 51 | 208 Already Reported [RFC5842] 52 | 209-225 Unassigned 53 | 226 IM Used [RFC3229] 54 | 227-299 Unassigned 55 | 300 Multiple Choices [RFC7231, Section 6.4.1] 56 | 301 Moved Permanently [RFC7231, Section 6.4.2] 57 | 302 Found [RFC7231, Section 6.4.3] 58 | 303 See Other [RFC7231, Section 6.4.4] 59 | 304 Not Modified [RFC7232, Section 4.1] 60 | 305 Use Proxy [RFC7231, Section 6.4.5] 61 | 306 (Unused) [RFC7231, Section 6.4.6] 62 | 307 Temporary Redirect [RFC7231, Section 6.4.7] 63 | 308 Permanent Redirect [RFC7538] 64 | 309-399 Unassigned 65 | 400 Bad Request [RFC7231, Section 6.5.1] 66 | 401 Unauthorized [RFC7235, Section 3.1] 67 | 402 Payment Required [RFC7231, Section 6.5.2] 68 | 403 Forbidden [RFC7231, Section 6.5.3] 69 | 404 Not Found [RFC7231, Section 6.5.4] 70 | 405 Method Not Allowed [RFC7231, Section 6.5.5] 71 | 406 Not Acceptable [RFC7231, Section 6.5.6] 72 | 407 Proxy Authentication Required [RFC7235, Section 3.2] 73 | 408 Request Timeout [RFC7231, Section 6.5.7] 74 | 409 Conflict [RFC7231, Section 6.5.8] 75 | 410 Gone [RFC7231, Section 6.5.9] 76 | 411 Length Required [RFC7231, Section 6.5.10] 77 | 412 Precondition Failed [RFC7232, Section 4.2] 78 | 413 Payload Too Large [RFC7231, Section 6.5.11] 79 | 414 URI Too Long [RFC7231, Section 6.5.12] 80 | 415 Unsupported Media Type [RFC7231, Section 6.5.13][RFC7694, Section 3] 81 | 416 Range Not Satisfiable [RFC7233, Section 4.4] 82 | 417 Expectation Failed [RFC7231, Section 6.5.14] 83 | 418-420 Unassigned 84 | 421 Misdirected Request [RFC7540, Section 9.1.2] 85 | 422 Unprocessable Entity [RFC4918] 86 | 423 Locked [RFC4918] 87 | 424 Failed Dependency [RFC4918] 88 | 425 Unassigned 89 | 426 Upgrade Required [RFC7231, Section 6.5.15] 90 | 427 Unassigned 91 | 428 Precondition Required [RFC6585] 92 | 429 Too Many Requests [RFC6585] 93 | 430 Unassigned 94 | 431 Request Header Fields Too Large [RFC6585] 95 | 432-450 Unassigned 96 | 451 Unavailable For Legal Reasons [RFC7725] 97 | 452-499 Unassigned 98 | 500 Internal Server Error [RFC7231, Section 6.6.1] 99 | 501 Not Implemented [RFC7231, Section 6.6.2] 100 | 502 Bad Gateway [RFC7231, Section 6.6.3] 101 | 503 Service Unavailable [RFC7231, Section 6.6.4] 102 | 504 Gateway Timeout [RFC7231, Section 6.6.5] 103 | 505 HTTP Version Not Supported [RFC7231, Section 6.6.6] 104 | 506 Variant Also Negotiates [RFC2295] 105 | 507 Insufficient Storage [RFC4918] 106 | 508 Loop Detected [RFC5842] 107 | 509 Unassigned 108 | 510 Not Extended [RFC2774] 109 | 511 Network Authentication Required [RFC6585] 110 | 512-599 Unassigned -------------------------------------------------------------------------------- /ExampleHTTPCodes/http-Status-Codes-w3.txt: -------------------------------------------------------------------------------- 1 | part of Hypertext Transfer Protocol -- HTTP/1.1 2 | RFC 2616 Fielding, et al. 3 | 10 Status Code Definitions 4 | https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html 5 | 6 | Each Status-Code is described below, including a description of which method(s) it can follow and any metainformation required in the response. 7 | 8 | 10.1 Informational 1xx 9 | 10 | This class of status code indicates a provisional response, consisting only of the Status-Line and optional headers, and is terminated by an empty line. There are no required headers for this class of status code. Since HTTP/1.0 did not define any 1xx status codes, servers MUST NOT send a 1xx response to an HTTP/1.0 client except under experimental conditions. 11 | 12 | A client MUST be prepared to accept one or more 1xx status responses prior to a regular response, even if the client does not expect a 100 (Continue) status message. Unexpected 1xx status responses MAY be ignored by a user agent. 13 | 14 | Proxies MUST forward 1xx responses, unless the connection between the proxy and its client has been closed, or unless the proxy itself requested the generation of the 1xx response. (For example, if a 15 | 16 | proxy adds a "Expect: 100-continue" field when it forwards a request, then it need not forward the corresponding 100 (Continue) response(s).) 17 | 18 | 10.1.1 100 Continue 19 | 20 | The client SHOULD continue with its request. This interim response is used to inform the client that the initial part of the request has been received and has not yet been rejected by the server. The client SHOULD continue by sending the remainder of the request or, if the request has already been completed, ignore this response. The server MUST send a final response after the request has been completed. See section 8.2.3 for detailed discussion of the use and handling of this status code. 21 | 22 | 10.1.2 101 Switching Protocols 23 | 24 | The server understands and is willing to comply with the client's request, via the Upgrade message header field (section 14.42), for a change in the application protocol being used on this connection. The server will switch protocols to those defined by the response's Upgrade header field immediately after the empty line which terminates the 101 response. 25 | 26 | The protocol SHOULD be switched only when it is advantageous to do so. For example, switching to a newer version of HTTP is advantageous over older versions, and switching to a real-time, synchronous protocol might be advantageous when delivering resources that use such features. 27 | 28 | 10.2 Successful 2xx 29 | 30 | This class of status code indicates that the client's request was successfully received, understood, and accepted. 31 | 32 | 10.2.1 200 OK 33 | 34 | The request has succeeded. The information returned with the response is dependent on the method used in the request, for example: 35 | 36 | GET an entity corresponding to the requested resource is sent in the response; 37 | 38 | HEAD the entity-header fields corresponding to the requested resource are sent in the response without any message-body; 39 | 40 | POST an entity describing or containing the result of the action; 41 | 42 | TRACE an entity containing the request message as received by the end server. 43 | 44 | 10.2.2 201 Created 45 | 46 | The request has been fulfilled and resulted in a new resource being created. The newly created resource can be referenced by the URI(s) returned in the entity of the response, with the most specific URI for the resource given by a Location header field. The response SHOULD include an entity containing a list of resource characteristics and location(s) from which the user or user agent can choose the one most appropriate. The entity format is specified by the media type given in the Content-Type header field. The origin server MUST create the resource before returning the 201 status code. If the action cannot be carried out immediately, the server SHOULD respond with 202 (Accepted) response instead. 47 | 48 | A 201 response MAY contain an ETag response header field indicating the current value of the entity tag for the requested variant just created, see section 14.19. 49 | 50 | 10.2.3 202 Accepted 51 | 52 | The request has been accepted for processing, but the processing has not been completed. The request might or might not eventually be acted upon, as it might be disallowed when processing actually takes place. There is no facility for re-sending a status code from an asynchronous operation such as this. 53 | 54 | The 202 response is intentionally non-committal. Its purpose is to allow a server to accept a request for some other process (perhaps a batch-oriented process that is only run once per day) without requiring that the user agent's connection to the server persist until the process is completed. The entity returned with this response SHOULD include an indication of the request's current status and either a pointer to a status monitor or some estimate of when the user can expect the request to be fulfilled. 55 | 56 | 10.2.4 203 Non-Authoritative Information 57 | 58 | The returned metainformation in the entity-header is not the definitive set as available from the origin server, but is gathered from a local or a third-party copy. The set presented MAY be a subset or superset of the original version. For example, including local annotation information about the resource might result in a superset of the metainformation known by the origin server. Use of this response code is not required and is only appropriate when the response would otherwise be 200 (OK). 59 | 60 | 10.2.5 204 No Content 61 | 62 | The server has fulfilled the request but does not need to return an entity-body, and might want to return updated metainformation. The response MAY include new or updated metainformation in the form of entity-headers, which if present SHOULD be associated with the requested variant. 63 | 64 | If the client is a user agent, it SHOULD NOT change its document view from that which caused the request to be sent. This response is primarily intended to allow input for actions to take place without causing a change to the user agent's active document view, although any new or updated metainformation SHOULD be applied to the document currently in the user agent's active view. 65 | 66 | The 204 response MUST NOT include a message-body, and thus is always terminated by the first empty line after the header fields. 67 | 68 | 10.2.6 205 Reset Content 69 | 70 | The server has fulfilled the request and the user agent SHOULD reset the document view which caused the request to be sent. This response is primarily intended to allow input for actions to take place via user input, followed by a clearing of the form in which the input is given so that the user can easily initiate another input action. The response MUST NOT include an entity. 71 | 72 | 10.2.7 206 Partial Content 73 | 74 | The server has fulfilled the partial GET request for the resource. The request MUST have included a Range header field (section 14.35) indicating the desired range, and MAY have included an If-Range header field (section 14.27) to make the request conditional. 75 | 76 | The response MUST include the following header fields: 77 | 78 | - Either a Content-Range header field (section 14.16) indicating 79 | the range included with this response, or a multipart/byteranges 80 | Content-Type including Content-Range fields for each part. If a 81 | Content-Length header field is present in the response, its 82 | value MUST match the actual number of OCTETs transmitted in the 83 | message-body. 84 | - Date 85 | - ETag and/or Content-Location, if the header would have been sent 86 | in a 200 response to the same request 87 | - Expires, Cache-Control, and/or Vary, if the field-value might 88 | differ from that sent in any previous response for the same 89 | variant 90 | If the 206 response is the result of an If-Range request that used a strong cache validator (see section 13.3.3), the response SHOULD NOT include other entity-headers. If the response is the result of an If-Range request that used a weak validator, the response MUST NOT include other entity-headers; this prevents inconsistencies between cached entity-bodies and updated headers. Otherwise, the response MUST include all of the entity-headers that would have been returned with a 200 (OK) response to the same request. 91 | 92 | A cache MUST NOT combine a 206 response with other previously cached content if the ETag or Last-Modified headers do not match exactly, see 13.5.4. 93 | 94 | A cache that does not support the Range and Content-Range headers MUST NOT cache 206 (Partial) responses. 95 | 96 | 10.3 Redirection 3xx 97 | 98 | This class of status code indicates that further action needs to be taken by the user agent in order to fulfill the request. The action required MAY be carried out by the user agent without interaction with the user if and only if the method used in the second request is GET or HEAD. A client SHOULD detect infinite redirection loops, since such loops generate network traffic for each redirection. 99 | 100 | Note: previous versions of this specification recommended a 101 | maximum of five redirections. Content developers should be aware 102 | that there might be clients that implement such a fixed 103 | limitation. 104 | 10.3.1 300 Multiple Choices 105 | 106 | The requested resource corresponds to any one of a set of representations, each with its own specific location, and agent- driven negotiation information (section 12) is being provided so that the user (or user agent) can select a preferred representation and redirect its request to that location. 107 | 108 | Unless it was a HEAD request, the response SHOULD include an entity containing a list of resource characteristics and location(s) from which the user or user agent can choose the one most appropriate. The entity format is specified by the media type given in the Content- Type header field. Depending upon the format and the capabilities of 109 | 110 | the user agent, selection of the most appropriate choice MAY be performed automatically. However, this specification does not define any standard for such automatic selection. 111 | 112 | If the server has a preferred choice of representation, it SHOULD include the specific URI for that representation in the Location field; user agents MAY use the Location field value for automatic redirection. This response is cacheable unless indicated otherwise. 113 | 114 | 10.3.2 301 Moved Permanently 115 | 116 | The requested resource has been assigned a new permanent URI and any future references to this resource SHOULD use one of the returned URIs. Clients with link editing capabilities ought to automatically re-link references to the Request-URI to one or more of the new references returned by the server, where possible. This response is cacheable unless indicated otherwise. 117 | 118 | The new permanent URI SHOULD be given by the Location field in the response. Unless the request method was HEAD, the entity of the response SHOULD contain a short hypertext note with a hyperlink to the new URI(s). 119 | 120 | If the 301 status code is received in response to a request other than GET or HEAD, the user agent MUST NOT automatically redirect the request unless it can be confirmed by the user, since this might change the conditions under which the request was issued. 121 | 122 | Note: When automatically redirecting a POST request after 123 | receiving a 301 status code, some existing HTTP/1.0 user agents 124 | will erroneously change it into a GET request. 125 | 10.3.3 302 Found 126 | 127 | The requested resource resides temporarily under a different URI. Since the redirection might be altered on occasion, the client SHOULD continue to use the Request-URI for future requests. This response is only cacheable if indicated by a Cache-Control or Expires header field. 128 | 129 | The temporary URI SHOULD be given by the Location field in the response. Unless the request method was HEAD, the entity of the response SHOULD contain a short hypertext note with a hyperlink to the new URI(s). 130 | 131 | If the 302 status code is received in response to a request other than GET or HEAD, the user agent MUST NOT automatically redirect the request unless it can be confirmed by the user, since this might change the conditions under which the request was issued. 132 | 133 | Note: RFC 1945 and RFC 2068 specify that the client is not allowed 134 | to change the method on the redirected request. However, most 135 | existing user agent implementations treat 302 as if it were a 303 136 | response, performing a GET on the Location field-value regardless 137 | of the original request method. The status codes 303 and 307 have 138 | been added for servers that wish to make unambiguously clear which 139 | kind of reaction is expected of the client. 140 | 10.3.4 303 See Other 141 | 142 | The response to the request can be found under a different URI and SHOULD be retrieved using a GET method on that resource. This method exists primarily to allow the output of a POST-activated script to redirect the user agent to a selected resource. The new URI is not a substitute reference for the originally requested resource. The 303 response MUST NOT be cached, but the response to the second (redirected) request might be cacheable. 143 | 144 | The different URI SHOULD be given by the Location field in the response. Unless the request method was HEAD, the entity of the response SHOULD contain a short hypertext note with a hyperlink to the new URI(s). 145 | 146 | Note: Many pre-HTTP/1.1 user agents do not understand the 303 147 | status. When interoperability with such clients is a concern, the 148 | 302 status code may be used instead, since most user agents react 149 | to a 302 response as described here for 303. 150 | 10.3.5 304 Not Modified 151 | 152 | If the client has performed a conditional GET request and access is allowed, but the document has not been modified, the server SHOULD respond with this status code. The 304 response MUST NOT contain a message-body, and thus is always terminated by the first empty line after the header fields. 153 | 154 | The response MUST include the following header fields: 155 | 156 | - Date, unless its omission is required by section 14.18.1 157 | If a clockless origin server obeys these rules, and proxies and clients add their own Date to any response received without one (as already specified by [RFC 2068], section 14.19), caches will operate correctly. 158 | 159 | - ETag and/or Content-Location, if the header would have been sent 160 | in a 200 response to the same request 161 | - Expires, Cache-Control, and/or Vary, if the field-value might 162 | differ from that sent in any previous response for the same 163 | variant 164 | If the conditional GET used a strong cache validator (see section 13.3.3), the response SHOULD NOT include other entity-headers. Otherwise (i.e., the conditional GET used a weak validator), the response MUST NOT include other entity-headers; this prevents inconsistencies between cached entity-bodies and updated headers. 165 | 166 | If a 304 response indicates an entity not currently cached, then the cache MUST disregard the response and repeat the request without the conditional. 167 | 168 | If a cache uses a received 304 response to update a cache entry, the cache MUST update the entry to reflect any new field values given in the response. 169 | 170 | 10.3.6 305 Use Proxy 171 | 172 | The requested resource MUST be accessed through the proxy given by the Location field. The Location field gives the URI of the proxy. The recipient is expected to repeat this single request via the proxy. 305 responses MUST only be generated by origin servers. 173 | 174 | Note: RFC 2068 was not clear that 305 was intended to redirect a 175 | single request, and to be generated by origin servers only. Not 176 | observing these limitations has significant security consequences. 177 | 10.3.7 306 (Unused) 178 | 179 | The 306 status code was used in a previous version of the specification, is no longer used, and the code is reserved. 180 | 181 | 10.3.8 307 Temporary Redirect 182 | 183 | The requested resource resides temporarily under a different URI. Since the redirection MAY be altered on occasion, the client SHOULD continue to use the Request-URI for future requests. This response is only cacheable if indicated by a Cache-Control or Expires header field. 184 | 185 | The temporary URI SHOULD be given by the Location field in the response. Unless the request method was HEAD, the entity of the response SHOULD contain a short hypertext note with a hyperlink to the new URI(s) , since many pre-HTTP/1.1 user agents do not understand the 307 status. Therefore, the note SHOULD contain the information necessary for a user to repeat the original request on the new URI. 186 | 187 | If the 307 status code is received in response to a request other than GET or HEAD, the user agent MUST NOT automatically redirect the request unless it can be confirmed by the user, since this might change the conditions under which the request was issued. 188 | 189 | 10.4 Client Error 4xx 190 | 191 | The 4xx class of status code is intended for cases in which the client seems to have erred. Except when responding to a HEAD request, the server SHOULD include an entity containing an explanation of the error situation, and whether it is a temporary or permanent condition. These status codes are applicable to any request method. User agents SHOULD display any included entity to the user. 192 | 193 | If the client is sending data, a server implementation using TCP SHOULD be careful to ensure that the client acknowledges receipt of the packet(s) containing the response, before the server closes the input connection. If the client continues sending data to the server after the close, the server's TCP stack will send a reset packet to the client, which may erase the client's unacknowledged input buffers before they can be read and interpreted by the HTTP application. 194 | 195 | 10.4.1 400 Bad Request 196 | 197 | The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications. 198 | 199 | 10.4.2 401 Unauthorized 200 | 201 | The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource. The client MAY repeat the request with a suitable Authorization header field (section 14.8). If the request already included Authorization credentials, then the 401 response indicates that authorization has been refused for those credentials. If the 401 response contains the same challenge as the prior response, and the user agent has already attempted authentication at least once, then the user SHOULD be presented the entity that was given in the response, since that entity might include relevant diagnostic information. HTTP access authentication is explained in "HTTP Authentication: Basic and Digest Access Authentication" [43]. 202 | 203 | 10.4.3 402 Payment Required 204 | 205 | This code is reserved for future use. 206 | 207 | 10.4.4 403 Forbidden 208 | 209 | The server understood the request, but is refusing to fulfill it. Authorization will not help and the request SHOULD NOT be repeated. If the request method was not HEAD and the server wishes to make public why the request has not been fulfilled, it SHOULD describe the reason for the refusal in the entity. If the server does not wish to make this information available to the client, the status code 404 (Not Found) can be used instead. 210 | 211 | 10.4.5 404 Not Found 212 | 213 | The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent. The 410 (Gone) status code SHOULD be used if the server knows, through some internally configurable mechanism, that an old resource is permanently unavailable and has no forwarding address. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable. 214 | 215 | 10.4.6 405 Method Not Allowed 216 | 217 | The method specified in the Request-Line is not allowed for the resource identified by the Request-URI. The response MUST include an Allow header containing a list of valid methods for the requested resource. 218 | 219 | 10.4.7 406 Not Acceptable 220 | 221 | The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request. 222 | 223 | Unless it was a HEAD request, the response SHOULD include an entity containing a list of available entity characteristics and location(s) from which the user or user agent can choose the one most appropriate. The entity format is specified by the media type given in the Content-Type header field. Depending upon the format and the capabilities of the user agent, selection of the most appropriate choice MAY be performed automatically. However, this specification does not define any standard for such automatic selection. 224 | 225 | Note: HTTP/1.1 servers are allowed to return responses which are 226 | not acceptable according to the accept headers sent in the 227 | request. In some cases, this may even be preferable to sending a 228 | 406 response. User agents are encouraged to inspect the headers of 229 | an incoming response to determine if it is acceptable. 230 | If the response could be unacceptable, a user agent SHOULD temporarily stop receipt of more data and query the user for a decision on further actions. 231 | 232 | 10.4.8 407 Proxy Authentication Required 233 | 234 | This code is similar to 401 (Unauthorized), but indicates that the client must first authenticate itself with the proxy. The proxy MUST return a Proxy-Authenticate header field (section 14.33) containing a challenge applicable to the proxy for the requested resource. The client MAY repeat the request with a suitable Proxy-Authorization header field (section 14.34). HTTP access authentication is explained in "HTTP Authentication: Basic and Digest Access Authentication" [43]. 235 | 236 | 10.4.9 408 Request Timeout 237 | 238 | The client did not produce a request within the time that the server was prepared to wait. The client MAY repeat the request without modifications at any later time. 239 | 240 | 10.4.10 409 Conflict 241 | 242 | The request could not be completed due to a conflict with the current state of the resource. This code is only allowed in situations where it is expected that the user might be able to resolve the conflict and resubmit the request. The response body SHOULD include enough 243 | 244 | information for the user to recognize the source of the conflict. Ideally, the response entity would include enough information for the user or user agent to fix the problem; however, that might not be possible and is not required. 245 | 246 | Conflicts are most likely to occur in response to a PUT request. For example, if versioning were being used and the entity being PUT included changes to a resource which conflict with those made by an earlier (third-party) request, the server might use the 409 response to indicate that it can't complete the request. In this case, the response entity would likely contain a list of the differences between the two versions in a format defined by the response Content-Type. 247 | 248 | 10.4.11 410 Gone 249 | 250 | The requested resource is no longer available at the server and no forwarding address is known. This condition is expected to be considered permanent. Clients with link editing capabilities SHOULD delete references to the Request-URI after user approval. If the server does not know, or has no facility to determine, whether or not the condition is permanent, the status code 404 (Not Found) SHOULD be used instead. This response is cacheable unless indicated otherwise. 251 | 252 | The 410 response is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable and that the server owners desire that remote links to that resource be removed. Such an event is common for limited-time, promotional services and for resources belonging to individuals no longer working at the server's site. It is not necessary to mark all permanently unavailable resources as "gone" or to keep the mark for any length of time -- that is left to the discretion of the server owner. 253 | 254 | 10.4.12 411 Length Required 255 | 256 | The server refuses to accept the request without a defined Content- Length. The client MAY repeat the request if it adds a valid Content-Length header field containing the length of the message-body in the request message. 257 | 258 | 10.4.13 412 Precondition Failed 259 | 260 | The precondition given in one or more of the request-header fields evaluated to false when it was tested on the server. This response code allows the client to place preconditions on the current resource metainformation (header field data) and thus prevent the requested method from being applied to a resource other than the one intended. 261 | 262 | 10.4.14 413 Request Entity Too Large 263 | 264 | The server is refusing to process a request because the request entity is larger than the server is willing or able to process. The server MAY close the connection to prevent the client from continuing the request. 265 | 266 | If the condition is temporary, the server SHOULD include a Retry- After header field to indicate that it is temporary and after what time the client MAY try again. 267 | 268 | 10.4.15 414 Request-URI Too Long 269 | 270 | The server is refusing to service the request because the Request-URI is longer than the server is willing to interpret. This rare condition is only likely to occur when a client has improperly converted a POST request to a GET request with long query information, when the client has descended into a URI "black hole" of redirection (e.g., a redirected URI prefix that points to a suffix of itself), or when the server is under attack by a client attempting to exploit security holes present in some servers using fixed-length buffers for reading or manipulating the Request-URI. 271 | 272 | 10.4.16 415 Unsupported Media Type 273 | 274 | The server is refusing to service the request because the entity of the request is in a format not supported by the requested resource for the requested method. 275 | 276 | 10.4.17 416 Requested Range Not Satisfiable 277 | 278 | A server SHOULD return a response with this status code if a request included a Range request-header field (section 14.35), and none of the range-specifier values in this field overlap the current extent of the selected resource, and the request did not include an If-Range request-header field. (For byte-ranges, this means that the first- byte-pos of all of the byte-range-spec values were greater than the current length of the selected resource.) 279 | 280 | When this status code is returned for a byte-range request, the response SHOULD include a Content-Range entity-header field specifying the current length of the selected resource (see section 14.16). This response MUST NOT use the multipart/byteranges content- type. 281 | 282 | 10.4.18 417 Expectation Failed 283 | 284 | The expectation given in an Expect request-header field (see section 14.20) could not be met by this server, or, if the server is a proxy, the server has unambiguous evidence that the request could not be met by the next-hop server. 285 | 286 | 10.5 Server Error 5xx 287 | 288 | Response status codes beginning with the digit "5" indicate cases in which the server is aware that it has erred or is incapable of performing the request. Except when responding to a HEAD request, the server SHOULD include an entity containing an explanation of the error situation, and whether it is a temporary or permanent condition. User agents SHOULD display any included entity to the user. These response codes are applicable to any request method. 289 | 290 | 10.5.1 500 Internal Server Error 291 | 292 | The server encountered an unexpected condition which prevented it from fulfilling the request. 293 | 294 | 10.5.2 501 Not Implemented 295 | 296 | The server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource. 297 | 298 | 10.5.3 502 Bad Gateway 299 | 300 | The server, while acting as a gateway or proxy, received an invalid response from the upstream server it accessed in attempting to fulfill the request. 301 | 302 | 10.5.4 503 Service Unavailable 303 | 304 | The server is currently unable to handle the request due to a temporary overloading or maintenance of the server. The implication is that this is a temporary condition which will be alleviated after some delay. If known, the length of the delay MAY be indicated in a Retry-After header. If no Retry-After is given, the client SHOULD handle the response as it would for a 500 response. 305 | 306 | Note: The existence of the 503 status code does not imply that a 307 | server must use it when becoming overloaded. Some servers may wish 308 | to simply refuse the connection. 309 | 10.5.5 504 Gateway Timeout 310 | 311 | The server, while acting as a gateway or proxy, did not receive a timely response from the upstream server specified by the URI (e.g. HTTP, FTP, LDAP) or some other auxiliary server (e.g. DNS) it needed to access in attempting to complete the request. 312 | 313 | Note: Note to implementors: some deployed proxies are known to 314 | return 400 or 500 when DNS lookups time out. 315 | 10.5.6 505 HTTP Version Not Supported 316 | 317 | The server does not support, or refuses to support, the HTTP protocol version that was used in the request message. The server is indicating that it is unable or unwilling to complete the request using the same major version as the client, as described in section 3.1, other than with this error message. The response SHOULD contain an entity describing why that version is not supported and what other protocols are supported by that server. -------------------------------------------------------------------------------- /ExampleHTTPCodes/http-Status-Codes.txt: -------------------------------------------------------------------------------- 1 | part of Hypertext Transfer Protocol -- HTTP/1.1 2 | RFC 2616 Fielding, et al. 3 | 10 Status Code Definitions 4 | https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html 5 | 6 | Each Status-Code is described below, including a description of which method(s) it can follow and any metainformation required in the response. 7 | 8 | 10.1 Informational 1xx 9 | 10 | This class of status code indicates a provisional response, consisting only of the Status-Line and optional headers, and is terminated by an empty line. There are no required headers for this class of status code. Since HTTP/1.0 did not define any 1xx status codes, servers MUST NOT send a 1xx response to an HTTP/1.0 client except under experimental conditions. 11 | 12 | A client MUST be prepared to accept one or more 1xx status responses prior to a regular response, even if the client does not expect a 100 (Continue) status message. Unexpected 1xx status responses MAY be ignored by a user agent. 13 | 14 | Proxies MUST forward 1xx responses, unless the connection between the proxy and its client has been closed, or unless the proxy itself requested the generation of the 1xx response. (For example, if a 15 | 16 | proxy adds a "Expect: 100-continue" field when it forwards a request, then it need not forward the corresponding 100 (Continue) response(s).) 17 | 18 | 10.1.1 100 Continue 19 | 20 | The client SHOULD continue with its request. This interim response is used to inform the client that the initial part of the request has been received and has not yet been rejected by the server. The client SHOULD continue by sending the remainder of the request or, if the request has already been completed, ignore this response. The server MUST send a final response after the request has been completed. See section 8.2.3 for detailed discussion of the use and handling of this status code. 21 | 22 | 10.1.2 101 Switching Protocols 23 | 24 | The server understands and is willing to comply with the client's request, via the Upgrade message header field (section 14.42), for a change in the application protocol being used on this connection. The server will switch protocols to those defined by the response's Upgrade header field immediately after the empty line which terminates the 101 response. 25 | 26 | The protocol SHOULD be switched only when it is advantageous to do so. For example, switching to a newer version of HTTP is advantageous over older versions, and switching to a real-time, synchronous protocol might be advantageous when delivering resources that use such features. 27 | 28 | 10.2 Successful 2xx 29 | 30 | This class of status code indicates that the client's request was successfully received, understood, and accepted. 31 | 32 | 10.2.1 200 OK 33 | 34 | The request has succeeded. The information returned with the response is dependent on the method used in the request, for example: 35 | 36 | GET an entity corresponding to the requested resource is sent in the response; 37 | 38 | HEAD the entity-header fields corresponding to the requested resource are sent in the response without any message-body; 39 | 40 | POST an entity describing or containing the result of the action; 41 | 42 | TRACE an entity containing the request message as received by the end server. 43 | 44 | 10.2.2 201 Created 45 | 46 | The request has been fulfilled and resulted in a new resource being created. The newly created resource can be referenced by the URI(s) returned in the entity of the response, with the most specific URI for the resource given by a Location header field. The response SHOULD include an entity containing a list of resource characteristics and location(s) from which the user or user agent can choose the one most appropriate. The entity format is specified by the media type given in the Content-Type header field. The origin server MUST create the resource before returning the 201 status code. If the action cannot be carried out immediately, the server SHOULD respond with 202 (Accepted) response instead. 47 | 48 | A 201 response MAY contain an ETag response header field indicating the current value of the entity tag for the requested variant just created, see section 14.19. 49 | 50 | 10.2.3 202 Accepted 51 | 52 | The request has been accepted for processing, but the processing has not been completed. The request might or might not eventually be acted upon, as it might be disallowed when processing actually takes place. There is no facility for re-sending a status code from an asynchronous operation such as this. 53 | 54 | The 202 response is intentionally non-committal. Its purpose is to allow a server to accept a request for some other process (perhaps a batch-oriented process that is only run once per day) without requiring that the user agent's connection to the server persist until the process is completed. The entity returned with this response SHOULD include an indication of the request's current status and either a pointer to a status monitor or some estimate of when the user can expect the request to be fulfilled. 55 | 56 | 10.2.4 203 Non-Authoritative Information 57 | 58 | The returned metainformation in the entity-header is not the definitive set as available from the origin server, but is gathered from a local or a third-party copy. The set presented MAY be a subset or superset of the original version. For example, including local annotation information about the resource might result in a superset of the metainformation known by the origin server. Use of this response code is not required and is only appropriate when the response would otherwise be 200 (OK). 59 | 60 | 10.2.5 204 No Content 61 | 62 | The server has fulfilled the request but does not need to return an entity-body, and might want to return updated metainformation. The response MAY include new or updated metainformation in the form of entity-headers, which if present SHOULD be associated with the requested variant. 63 | 64 | If the client is a user agent, it SHOULD NOT change its document view from that which caused the request to be sent. This response is primarily intended to allow input for actions to take place without causing a change to the user agent's active document view, although any new or updated metainformation SHOULD be applied to the document currently in the user agent's active view. 65 | 66 | The 204 response MUST NOT include a message-body, and thus is always terminated by the first empty line after the header fields. 67 | 68 | 10.2.6 205 Reset Content 69 | 70 | The server has fulfilled the request and the user agent SHOULD reset the document view which caused the request to be sent. This response is primarily intended to allow input for actions to take place via user input, followed by a clearing of the form in which the input is given so that the user can easily initiate another input action. The response MUST NOT include an entity. 71 | 72 | 10.2.7 206 Partial Content 73 | 74 | The server has fulfilled the partial GET request for the resource. The request MUST have included a Range header field (section 14.35) indicating the desired range, and MAY have included an If-Range header field (section 14.27) to make the request conditional. 75 | 76 | The response MUST include the following header fields: 77 | 78 | - Either a Content-Range header field (section 14.16) indicating 79 | the range included with this response, or a multipart/byteranges 80 | Content-Type including Content-Range fields for each part. If a 81 | Content-Length header field is present in the response, its 82 | value MUST match the actual number of OCTETs transmitted in the 83 | message-body. 84 | - Date 85 | - ETag and/or Content-Location, if the header would have been sent 86 | in a 200 response to the same request 87 | - Expires, Cache-Control, and/or Vary, if the field-value might 88 | differ from that sent in any previous response for the same 89 | variant 90 | If the 206 response is the result of an If-Range request that used a strong cache validator (see section 13.3.3), the response SHOULD NOT include other entity-headers. If the response is the result of an If-Range request that used a weak validator, the response MUST NOT include other entity-headers; this prevents inconsistencies between cached entity-bodies and updated headers. Otherwise, the response MUST include all of the entity-headers that would have been returned with a 200 (OK) response to the same request. 91 | 92 | A cache MUST NOT combine a 206 response with other previously cached content if the ETag or Last-Modified headers do not match exactly, see 13.5.4. 93 | 94 | A cache that does not support the Range and Content-Range headers MUST NOT cache 206 (Partial) responses. 95 | 96 | 10.3 Redirection 3xx 97 | 98 | This class of status code indicates that further action needs to be taken by the user agent in order to fulfill the request. The action required MAY be carried out by the user agent without interaction with the user if and only if the method used in the second request is GET or HEAD. A client SHOULD detect infinite redirection loops, since such loops generate network traffic for each redirection. 99 | 100 | Note: previous versions of this specification recommended a 101 | maximum of five redirections. Content developers should be aware 102 | that there might be clients that implement such a fixed 103 | limitation. 104 | 10.3.1 300 Multiple Choices 105 | 106 | The requested resource corresponds to any one of a set of representations, each with its own specific location, and agent- driven negotiation information (section 12) is being provided so that the user (or user agent) can select a preferred representation and redirect its request to that location. 107 | 108 | Unless it was a HEAD request, the response SHOULD include an entity containing a list of resource characteristics and location(s) from which the user or user agent can choose the one most appropriate. The entity format is specified by the media type given in the Content- Type header field. Depending upon the format and the capabilities of 109 | 110 | the user agent, selection of the most appropriate choice MAY be performed automatically. However, this specification does not define any standard for such automatic selection. 111 | 112 | If the server has a preferred choice of representation, it SHOULD include the specific URI for that representation in the Location field; user agents MAY use the Location field value for automatic redirection. This response is cacheable unless indicated otherwise. 113 | 114 | 10.3.2 301 Moved Permanently 115 | 116 | The requested resource has been assigned a new permanent URI and any future references to this resource SHOULD use one of the returned URIs. Clients with link editing capabilities ought to automatically re-link references to the Request-URI to one or more of the new references returned by the server, where possible. This response is cacheable unless indicated otherwise. 117 | 118 | The new permanent URI SHOULD be given by the Location field in the response. Unless the request method was HEAD, the entity of the response SHOULD contain a short hypertext note with a hyperlink to the new URI(s). 119 | 120 | If the 301 status code is received in response to a request other than GET or HEAD, the user agent MUST NOT automatically redirect the request unless it can be confirmed by the user, since this might change the conditions under which the request was issued. 121 | 122 | Note: When automatically redirecting a POST request after 123 | receiving a 301 status code, some existing HTTP/1.0 user agents 124 | will erroneously change it into a GET request. 125 | 10.3.3 302 Found 126 | 127 | The requested resource resides temporarily under a different URI. Since the redirection might be altered on occasion, the client SHOULD continue to use the Request-URI for future requests. This response is only cacheable if indicated by a Cache-Control or Expires header field. 128 | 129 | The temporary URI SHOULD be given by the Location field in the response. Unless the request method was HEAD, the entity of the response SHOULD contain a short hypertext note with a hyperlink to the new URI(s). 130 | 131 | If the 302 status code is received in response to a request other than GET or HEAD, the user agent MUST NOT automatically redirect the request unless it can be confirmed by the user, since this might change the conditions under which the request was issued. 132 | 133 | Note: RFC 1945 and RFC 2068 specify that the client is not allowed 134 | to change the method on the redirected request. However, most 135 | existing user agent implementations treat 302 as if it were a 303 136 | response, performing a GET on the Location field-value regardless 137 | of the original request method. The status codes 303 and 307 have 138 | been added for servers that wish to make unambiguously clear which 139 | kind of reaction is expected of the client. 140 | 10.3.4 303 See Other 141 | 142 | The response to the request can be found under a different URI and SHOULD be retrieved using a GET method on that resource. This method exists primarily to allow the output of a POST-activated script to redirect the user agent to a selected resource. The new URI is not a substitute reference for the originally requested resource. The 303 response MUST NOT be cached, but the response to the second (redirected) request might be cacheable. 143 | 144 | The different URI SHOULD be given by the Location field in the response. Unless the request method was HEAD, the entity of the response SHOULD contain a short hypertext note with a hyperlink to the new URI(s). 145 | 146 | Note: Many pre-HTTP/1.1 user agents do not understand the 303 147 | status. When interoperability with such clients is a concern, the 148 | 302 status code may be used instead, since most user agents react 149 | to a 302 response as described here for 303. 150 | 10.3.5 304 Not Modified 151 | 152 | If the client has performed a conditional GET request and access is allowed, but the document has not been modified, the server SHOULD respond with this status code. The 304 response MUST NOT contain a message-body, and thus is always terminated by the first empty line after the header fields. 153 | 154 | The response MUST include the following header fields: 155 | 156 | - Date, unless its omission is required by section 14.18.1 157 | If a clockless origin server obeys these rules, and proxies and clients add their own Date to any response received without one (as already specified by [RFC 2068], section 14.19), caches will operate correctly. 158 | 159 | - ETag and/or Content-Location, if the header would have been sent 160 | in a 200 response to the same request 161 | - Expires, Cache-Control, and/or Vary, if the field-value might 162 | differ from that sent in any previous response for the same 163 | variant 164 | If the conditional GET used a strong cache validator (see section 13.3.3), the response SHOULD NOT include other entity-headers. Otherwise (i.e., the conditional GET used a weak validator), the response MUST NOT include other entity-headers; this prevents inconsistencies between cached entity-bodies and updated headers. 165 | 166 | If a 304 response indicates an entity not currently cached, then the cache MUST disregard the response and repeat the request without the conditional. 167 | 168 | If a cache uses a received 304 response to update a cache entry, the cache MUST update the entry to reflect any new field values given in the response. 169 | 170 | 10.3.6 305 Use Proxy 171 | 172 | The requested resource MUST be accessed through the proxy given by the Location field. The Location field gives the URI of the proxy. The recipient is expected to repeat this single request via the proxy. 305 responses MUST only be generated by origin servers. 173 | 174 | Note: RFC 2068 was not clear that 305 was intended to redirect a 175 | single request, and to be generated by origin servers only. Not 176 | observing these limitations has significant security consequences. 177 | 10.3.7 306 (Unused) 178 | 179 | The 306 status code was used in a previous version of the specification, is no longer used, and the code is reserved. 180 | 181 | 10.3.8 307 Temporary Redirect 182 | 183 | The requested resource resides temporarily under a different URI. Since the redirection MAY be altered on occasion, the client SHOULD continue to use the Request-URI for future requests. This response is only cacheable if indicated by a Cache-Control or Expires header field. 184 | 185 | The temporary URI SHOULD be given by the Location field in the response. Unless the request method was HEAD, the entity of the response SHOULD contain a short hypertext note with a hyperlink to the new URI(s) , since many pre-HTTP/1.1 user agents do not understand the 307 status. Therefore, the note SHOULD contain the information necessary for a user to repeat the original request on the new URI. 186 | 187 | If the 307 status code is received in response to a request other than GET or HEAD, the user agent MUST NOT automatically redirect the request unless it can be confirmed by the user, since this might change the conditions under which the request was issued. 188 | 189 | 10.4 Client Error 4xx 190 | 191 | The 4xx class of status code is intended for cases in which the client seems to have erred. Except when responding to a HEAD request, the server SHOULD include an entity containing an explanation of the error situation, and whether it is a temporary or permanent condition. These status codes are applicable to any request method. User agents SHOULD display any included entity to the user. 192 | 193 | If the client is sending data, a server implementation using TCP SHOULD be careful to ensure that the client acknowledges receipt of the packet(s) containing the response, before the server closes the input connection. If the client continues sending data to the server after the close, the server's TCP stack will send a reset packet to the client, which may erase the client's unacknowledged input buffers before they can be read and interpreted by the HTTP application. 194 | 195 | 10.4.1 400 Bad Request 196 | 197 | The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications. 198 | 199 | 10.4.2 401 Unauthorized 200 | 201 | The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource. The client MAY repeat the request with a suitable Authorization header field (section 14.8). If the request already included Authorization credentials, then the 401 response indicates that authorization has been refused for those credentials. If the 401 response contains the same challenge as the prior response, and the user agent has already attempted authentication at least once, then the user SHOULD be presented the entity that was given in the response, since that entity might include relevant diagnostic information. HTTP access authentication is explained in "HTTP Authentication: Basic and Digest Access Authentication" [43]. 202 | 203 | 10.4.3 402 Payment Required 204 | 205 | This code is reserved for future use. 206 | 207 | 10.4.4 403 Forbidden 208 | 209 | The server understood the request, but is refusing to fulfill it. Authorization will not help and the request SHOULD NOT be repeated. If the request method was not HEAD and the server wishes to make public why the request has not been fulfilled, it SHOULD describe the reason for the refusal in the entity. If the server does not wish to make this information available to the client, the status code 404 (Not Found) can be used instead. 210 | 211 | 10.4.5 404 Not Found 212 | 213 | The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent. The 410 (Gone) status code SHOULD be used if the server knows, through some internally configurable mechanism, that an old resource is permanently unavailable and has no forwarding address. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable. 214 | 215 | 10.4.6 405 Method Not Allowed 216 | 217 | The method specified in the Request-Line is not allowed for the resource identified by the Request-URI. The response MUST include an Allow header containing a list of valid methods for the requested resource. 218 | 219 | 10.4.7 406 Not Acceptable 220 | 221 | The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request. 222 | 223 | Unless it was a HEAD request, the response SHOULD include an entity containing a list of available entity characteristics and location(s) from which the user or user agent can choose the one most appropriate. The entity format is specified by the media type given in the Content-Type header field. Depending upon the format and the capabilities of the user agent, selection of the most appropriate choice MAY be performed automatically. However, this specification does not define any standard for such automatic selection. 224 | 225 | Note: HTTP/1.1 servers are allowed to return responses which are 226 | not acceptable according to the accept headers sent in the 227 | request. In some cases, this may even be preferable to sending a 228 | 406 response. User agents are encouraged to inspect the headers of 229 | an incoming response to determine if it is acceptable. 230 | If the response could be unacceptable, a user agent SHOULD temporarily stop receipt of more data and query the user for a decision on further actions. 231 | 232 | 10.4.8 407 Proxy Authentication Required 233 | 234 | This code is similar to 401 (Unauthorized), but indicates that the client must first authenticate itself with the proxy. The proxy MUST return a Proxy-Authenticate header field (section 14.33) containing a challenge applicable to the proxy for the requested resource. The client MAY repeat the request with a suitable Proxy-Authorization header field (section 14.34). HTTP access authentication is explained in "HTTP Authentication: Basic and Digest Access Authentication" [43]. 235 | 236 | 10.4.9 408 Request Timeout 237 | 238 | The client did not produce a request within the time that the server was prepared to wait. The client MAY repeat the request without modifications at any later time. 239 | 240 | 10.4.10 409 Conflict 241 | 242 | The request could not be completed due to a conflict with the current state of the resource. This code is only allowed in situations where it is expected that the user might be able to resolve the conflict and resubmit the request. The response body SHOULD include enough 243 | 244 | information for the user to recognize the source of the conflict. Ideally, the response entity would include enough information for the user or user agent to fix the problem; however, that might not be possible and is not required. 245 | 246 | Conflicts are most likely to occur in response to a PUT request. For example, if versioning were being used and the entity being PUT included changes to a resource which conflict with those made by an earlier (third-party) request, the server might use the 409 response to indicate that it can't complete the request. In this case, the response entity would likely contain a list of the differences between the two versions in a format defined by the response Content-Type. 247 | 248 | 10.4.11 410 Gone 249 | 250 | The requested resource is no longer available at the server and no forwarding address is known. This condition is expected to be considered permanent. Clients with link editing capabilities SHOULD delete references to the Request-URI after user approval. If the server does not know, or has no facility to determine, whether or not the condition is permanent, the status code 404 (Not Found) SHOULD be used instead. This response is cacheable unless indicated otherwise. 251 | 252 | The 410 response is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable and that the server owners desire that remote links to that resource be removed. Such an event is common for limited-time, promotional services and for resources belonging to individuals no longer working at the server's site. It is not necessary to mark all permanently unavailable resources as "gone" or to keep the mark for any length of time -- that is left to the discretion of the server owner. 253 | 254 | 10.4.12 411 Length Required 255 | 256 | The server refuses to accept the request without a defined Content- Length. The client MAY repeat the request if it adds a valid Content-Length header field containing the length of the message-body in the request message. 257 | 258 | 10.4.13 412 Precondition Failed 259 | 260 | The precondition given in one or more of the request-header fields evaluated to false when it was tested on the server. This response code allows the client to place preconditions on the current resource metainformation (header field data) and thus prevent the requested method from being applied to a resource other than the one intended. 261 | 262 | 10.4.14 413 Request Entity Too Large 263 | 264 | The server is refusing to process a request because the request entity is larger than the server is willing or able to process. The server MAY close the connection to prevent the client from continuing the request. 265 | 266 | If the condition is temporary, the server SHOULD include a Retry- After header field to indicate that it is temporary and after what time the client MAY try again. 267 | 268 | 10.4.15 414 Request-URI Too Long 269 | 270 | The server is refusing to service the request because the Request-URI is longer than the server is willing to interpret. This rare condition is only likely to occur when a client has improperly converted a POST request to a GET request with long query information, when the client has descended into a URI "black hole" of redirection (e.g., a redirected URI prefix that points to a suffix of itself), or when the server is under attack by a client attempting to exploit security holes present in some servers using fixed-length buffers for reading or manipulating the Request-URI. 271 | 272 | 10.4.16 415 Unsupported Media Type 273 | 274 | The server is refusing to service the request because the entity of the request is in a format not supported by the requested resource for the requested method. 275 | 276 | 10.4.17 416 Requested Range Not Satisfiable 277 | 278 | A server SHOULD return a response with this status code if a request included a Range request-header field (section 14.35), and none of the range-specifier values in this field overlap the current extent of the selected resource, and the request did not include an If-Range request-header field. (For byte-ranges, this means that the first- byte-pos of all of the byte-range-spec values were greater than the current length of the selected resource.) 279 | 280 | When this status code is returned for a byte-range request, the response SHOULD include a Content-Range entity-header field specifying the current length of the selected resource (see section 14.16). This response MUST NOT use the multipart/byteranges content- type. 281 | 282 | 10.4.18 417 Expectation Failed 283 | 284 | The expectation given in an Expect request-header field (see section 14.20) could not be met by this server, or, if the server is a proxy, the server has unambiguous evidence that the request could not be met by the next-hop server. 285 | 286 | 10.5 Server Error 5xx 287 | 288 | Response status codes beginning with the digit "5" indicate cases in which the server is aware that it has erred or is incapable of performing the request. Except when responding to a HEAD request, the server SHOULD include an entity containing an explanation of the error situation, and whether it is a temporary or permanent condition. User agents SHOULD display any included entity to the user. These response codes are applicable to any request method. 289 | 290 | 10.5.1 500 Internal Server Error 291 | 292 | The server encountered an unexpected condition which prevented it from fulfilling the request. 293 | 294 | 10.5.2 501 Not Implemented 295 | 296 | The server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource. 297 | 298 | 10.5.3 502 Bad Gateway 299 | 300 | The server, while acting as a gateway or proxy, received an invalid response from the upstream server it accessed in attempting to fulfill the request. 301 | 302 | 10.5.4 503 Service Unavailable 303 | 304 | The server is currently unable to handle the request due to a temporary overloading or maintenance of the server. The implication is that this is a temporary condition which will be alleviated after some delay. If known, the length of the delay MAY be indicated in a Retry-After header. If no Retry-After is given, the client SHOULD handle the response as it would for a 500 response. 305 | 306 | Note: The existence of the 503 status code does not imply that a 307 | server must use it when becoming overloaded. Some servers may wish 308 | to simply refuse the connection. 309 | 10.5.5 504 Gateway Timeout 310 | 311 | The server, while acting as a gateway or proxy, did not receive a timely response from the upstream server specified by the URI (e.g. HTTP, FTP, LDAP) or some other auxiliary server (e.g. DNS) it needed to access in attempting to complete the request. 312 | 313 | Note: Note to implementors: some deployed proxies are known to 314 | return 400 or 500 when DNS lookups time out. 315 | 10.5.6 505 HTTP Version Not Supported 316 | 317 | The server does not support, or refuses to support, the HTTP protocol version that was used in the request message. The server is indicating that it is unable or unwilling to complete the request using the same major version as the client, as described in section 3.1, other than with this error message. The response SHOULD contain an entity describing why that version is not supported and what other protocols are supported by that server. -------------------------------------------------------------------------------- /REACT-TODO-APP-for-SwaggerAPI/.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | .DS_Store 3 | -------------------------------------------------------------------------------- /REACT-TODO-APP-for-SwaggerAPI/README.md: -------------------------------------------------------------------------------- 1 | # React UI for Todo API 2 | This React application is a sample frontend 3 | This is Todo API server built with Swagger, part of the Node.js Codeless API Creation: Up And Running With Swagger. 4 | http://btreepress.com/blog/portfolio-items/codeless-node-apis-with-swagger-open-api-specification/ 5 | https://www.udemy.com/course/1076002/ 6 | 7 | ## Getting Started 8 | - Clone the repo. 9 | - Install dependencies with `npm install` 10 | - Launch the application with `webpack -w` 11 | - Ensure you have the Todo API server up and running 12 | 13 | -------------------------------------------------------------------------------- /REACT-TODO-APP-for-SwaggerAPI/app/App.js: -------------------------------------------------------------------------------- 1 | var React = require('react'); 2 | var ReactDOM = require('react-dom'); 3 | var Router = require('react-router').Router; 4 | var routes = require('./config/routes'); 5 | 6 | ReactDOM.render( 7 | {routes}, 8 | document.getElementById('app') 9 | ) 10 | -------------------------------------------------------------------------------- /REACT-TODO-APP-for-SwaggerAPI/app/components/Home.js: -------------------------------------------------------------------------------- 1 | var React = require('react'); 2 | 3 | var Home = React.createClass({ 4 | render: function() { 5 | return( 6 |

7 | All Todos 8 |

9 | ) 10 | } 11 | }) 12 | 13 | module.exports = Home; 14 | -------------------------------------------------------------------------------- /REACT-TODO-APP-for-SwaggerAPI/app/components/Main.js: -------------------------------------------------------------------------------- 1 | var React = require('react'); 2 | var Todo = require('./Todo'); 3 | 4 | var Main = React.createClass({ 5 | render: function() { 6 | return( 7 |
8 | 13 |
14 | 15 |
16 |
17 | ) 18 | } 19 | }); 20 | 21 | module.exports = Main; 22 | -------------------------------------------------------------------------------- /REACT-TODO-APP-for-SwaggerAPI/app/components/Todo.js: -------------------------------------------------------------------------------- 1 | var React = require('react'); 2 | var Router = require('react-router'); 3 | var AllTodos = require('./Todos/AllTodos'); 4 | var SingleTodo = require('./Todos/SingleTodo'); 5 | var NewTodo = require('./Todos/NewTodo'); 6 | var Axios = require('axios'); 7 | 8 | var Todo = React.createClass({ 9 | getInitialState: function() { 10 | return { 11 | // Define default schema from API 12 | todos: [ 13 | { 14 | todo_id: '', 15 | todo: '', 16 | author: '', 17 | duedate: '', 18 | completed: '' 19 | } 20 | ], 21 | todo: { 22 | todo_id: '', 23 | todo: '', 24 | author: '', 25 | duedate: '', 26 | completed: '' 27 | } 28 | } 29 | }, 30 | componentDidMount: function() { 31 | // get Todos from Elasticsearch 32 | var _this = this; 33 | Axios.get('http://localhost:10010') 34 | .then(function(res){ 35 | _this.setState({todos: res.data}); 36 | }) 37 | }, 38 | handleAddTodo: function(newtodo) { 39 | // post new note to Elasticsearch 40 | newtodo.todo_id = this.state.todos.length; 41 | Axios.post('http://localhost:10010', newtodo) 42 | .then(function(res){ 43 | console.log(res); 44 | }) 45 | }, 46 | displayTodo: function(todo){ 47 | this.setState({todo: todo}); 48 | }, 49 | render: function() { 50 | return ( 51 |
52 |
53 | 54 |
55 |
56 | 57 |
58 |
59 | 60 |
61 |
62 | ) 63 | } 64 | }) 65 | 66 | module.exports = Todo; 67 | -------------------------------------------------------------------------------- /REACT-TODO-APP-for-SwaggerAPI/app/components/Todos/AddTodo.js: -------------------------------------------------------------------------------- 1 | var React = require('react'); 2 | var newTodo = { 3 | todo: '', 4 | datecreated: new Date(), 5 | author: '', 6 | duedate: new Date(), 7 | completed: false 8 | } 9 | 10 | var AddTodo = React.createClass({ 11 | propTypes: { 12 | addTodo: React.PropTypes.func.isRequired 13 | }, 14 | setRef: function(ref) { 15 | this.todo = ref; 16 | }, 17 | setTodo: function(ref) { 18 | console.log(ref); 19 | newTodo.todo = ref.value 20 | }, 21 | handleTodo: function(event) { 22 | newTodo.todo = event.target.value; 23 | }, 24 | handleAuthor: function(event) { 25 | newTodo.author = event.target.value; 26 | }, 27 | handleDate: function(event) { 28 | newTodo.duedate = new Date(event.target.value); 29 | }, 30 | handleSubmit: function() { 31 | this.props.addTodo(newTodo); 32 | }, 33 | render: function() { 34 | return ( 35 |
36 | 37 | 38 | 39 | 40 | 41 | 42 |
43 | ) 44 | } 45 | }); 46 | 47 | module.exports = AddTodo; 48 | -------------------------------------------------------------------------------- /REACT-TODO-APP-for-SwaggerAPI/app/components/Todos/AllTodos.js: -------------------------------------------------------------------------------- 1 | var React = require('react'); 2 | 3 | var AllTodos = React.createClass({ 4 | propTypes: { 5 | displayTodo: React.PropTypes.func.isRequired 6 | }, 7 | handleSelect: function(todo){ 8 | this.props.displayTodo(todo); 9 | }, 10 | render: function() { 11 | var _this = this; 12 | var todos = this.props.todos.map(function(todo, index){ 13 | return ( 14 |
  • 15 |
    16 | 17 | 18 | 19 |
    20 |
    21 | Due date: {todo.duedate} 22 |
    23 |
  • 24 | ) 25 | }); 26 | return ( 27 | 30 | ) 31 | } 32 | }); 33 | 34 | module.exports = AllTodos; 35 | -------------------------------------------------------------------------------- /REACT-TODO-APP-for-SwaggerAPI/app/components/Todos/NewTodo.js: -------------------------------------------------------------------------------- 1 | var React = require('react'); 2 | var AddTodo = require('./AddTodo'); 3 | 4 | var NewTodo = React.createClass({ 5 | propTypes: { 6 | addTodo: React.PropTypes.func.isRequired 7 | }, 8 | render: function() { 9 | return ( 10 |
    11 |

    Add New Todo

    12 | 13 |
    14 | ) 15 | } 16 | }); 17 | 18 | module.exports = NewTodo; 19 | -------------------------------------------------------------------------------- /REACT-TODO-APP-for-SwaggerAPI/app/components/Todos/SingleTodo.js: -------------------------------------------------------------------------------- 1 | var React = require('react'); 2 | var Axios = require('axios'); 3 | var todo = ''; 4 | 5 | var SingleTodo = React.createClass({ 6 | propTypes: { 7 | todo: React.PropTypes.object.isRequired 8 | }, 9 | handleTodoChange: function(event) { 10 | var updatedTodo = this.props.todo; 11 | updatedTodo.todo = event.target.value 12 | this.props.displayTodo(updatedTodo); 13 | }, 14 | handleAuthorChange: function(event) { 15 | var updatedTodo = this.props.todo; 16 | updatedTodo.author = event.target.value 17 | this.props.displayTodo(updatedTodo); 18 | }, 19 | handleDateChange: function(event) { 20 | var updatedTodo = this.props.todo; 21 | updatedTodo.duedate = event.target.value 22 | this.props.displayTodo(updatedTodo); 23 | }, 24 | handleCompleted: function(event) { 25 | var updatedTodo = this.props.todo; 26 | updatedTodo.completed = event.target.value 27 | this.props.displayTodo(updatedTodo); 28 | }, 29 | handleUpdate: function() { 30 | // handle update Elasticsearch 31 | Axios.put('http://localhost:10010/todo/' + this.props.todo.todo_id, this.props.todo) 32 | .then(function(res) { 33 | console.log(res); 34 | }); 35 | }, 36 | render: function() { 37 | return ( 38 |
    39 | 40 | 41 | 42 | 43 | 44 |
    45 | ) 46 | } 47 | }); 48 | 49 | module.exports = SingleTodo; 50 | -------------------------------------------------------------------------------- /REACT-TODO-APP-for-SwaggerAPI/app/config/routes.js: -------------------------------------------------------------------------------- 1 | var React = require('react'); 2 | var Main = require('../components/Main'); 3 | var Home = require('../components/Home'); 4 | var Todo = require('../components/Todo'); 5 | var Router = require('react-router'); 6 | var Route = Router.Route; 7 | var IndexRoute = Router.IndexRoute; 8 | 9 | module.exports = ( 10 | 11 | 12 | 13 | ) 14 | -------------------------------------------------------------------------------- /REACT-TODO-APP-for-SwaggerAPI/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "react-todo", 3 | "version": "1.0.0", 4 | "description": "React App for - Node.js Codeless API Creation: Up And Running With Swagger", 5 | "main": "index.js", 6 | "scripts": { 7 | "test": "echo \"Error: no test specified\" && exit 1" 8 | }, 9 | "keywords": [], 10 | "author": "Luke Angel - BTREEPRESS.com - BTREE.co - LUKENAGEL.co", 11 | 12 | "license": "ISC", 13 | "dependencies": { 14 | "axios": "^0.15.2", 15 | "firebase": "^3.5.3", 16 | "history": "^1.13.1", 17 | "react": "^0.14.3", 18 | "react-dom": "^0.14.3", 19 | "react-router": "^1.0.1", 20 | "reactfire": "^1.0.0" 21 | }, 22 | "devDependencies": { 23 | "babel-core": "^6.3.13", 24 | "babel-loader": "^6.2.0", 25 | "babel-preset-es2015": "^6.3.13", 26 | "babel-preset-react": "^6.3.13", 27 | "webpack": "^1.13.3" 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /REACT-TODO-APP-for-SwaggerAPI/public/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Todo Application 6 | 7 | 8 | 9 |
    10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /REACT-TODO-APP-for-SwaggerAPI/webpack.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | entry: "./app/App.js", 3 | output: { 4 | filename: "public/bundle.js" 5 | }, 6 | module: { 7 | loaders: [ 8 | { 9 | test: /\.jsx?$/, 10 | exclude: /(node_modules|bower_components)/, 11 | loader: 'babel', 12 | query: { 13 | presets: ['react', 'es2015'] 14 | } 15 | } 16 | ] 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /ReadMe.md: -------------------------------------------------------------------------------- 1 | # Node.js Codeless API Creation: Up And Running With Swagger. 2 | exercise files for the course. Node.js Codeless API Creation: Up And Running With Swagger. 3 | 4 | ##Course Links 5 | http://btreepress.com/blog/portfolio-items/codeless-node-apis-with-swagger-open-api-specification/ 6 | 7 | https://www.udemy.com/course/1076002/ 8 | 9 | 10 | #This repo contains three sections: 11 | 12 | ###Example-HTTP-Codes 13 | 14 | These are the standard http codes for you to enjoy. 15 | 16 | ###The TodoAPI is the final version of the API. 17 | 18 | We will build the entirety of the api throughout the course. 19 | 20 | ###REACT-TODO-APP 21 | Contains the REACT TODO APP that we will use to connect to the API 22 | 23 | 24 | #API Instructions 25 | 26 | ## Getting Started 27 | - Clone the repo. Switch to the todo-api directory in the repo downloaded. 28 | - Install dependencies with `npm install` 29 | - Ensure you have swagger installed globally with `npm install swagger -g` 30 | - Start the node.js application using Swagger with `swagger project start` 31 | - Alternately, you can run the API server using nodejs-dashboard with `npm run dev` 32 | - Ensure you have nodejs-dashboard installed with `npm install nodejs-dashboard -g` 33 | - Launch the swagger editor to view/edit the API definition with `swagger project edit` 34 | 35 | ## Using jmeter 36 | - Download and extract jmeter 37 | - Launch jmeter by navigating to the folder you downloaded, run `bin/jmeter` 38 | - Open the `jmeterTest.jmx` file in this repo to load test the API server 39 | 40 | ## Additional Info: 41 | - Swagger NPM package can be found [here](https://www.npmjs.com/package/swagger) 42 | - Elasticsearch NPM client used is [here](https://www.npmjs.com/package/elasticsearch) 43 | - nodejs-dashboard from Formidable Labs can be found [here](https://github.com/FormidableLabs/nodejs-dashboard) 44 | - Apache jmeter can be found [here](http://jmeter.apache.org/) 45 | 46 | 47 | 48 | # React Instructions 49 | This React application is a sample frontend 50 | This is Todo API server built with Swagger, part of the Node.js Codeless API Creation: Up And Running With Swagger. 51 | http://btreepress.com/blog/portfolio-items/codeless-node-apis-with-swagger-open-api-specification/ 52 | https://www.udemy.com/course/1076002/ 53 | 54 | ## Getting Started 55 | - Clone the repo. 56 | - Install dependencies with `npm install` 57 | - Launch the application with `webpack -w` 58 | - Ensure you have the Todo API server up and running 59 | 60 | -------------------------------------------------------------------------------- /TODO-API-for-swagger-genereated-node-apis-server/.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | node_modules 3 | -------------------------------------------------------------------------------- /TODO-API-for-swagger-genereated-node-apis-server/README.md: -------------------------------------------------------------------------------- 1 | # Todo API Server built with [Swagger (a.k.a. The OpenAPI Spec)](http://swagger.io/) 2 | 3 | This is Todo API server built with Swagger, part of the Node.js Codeless API Creation: Up And Running With Swagger. 4 | http://btreepress.com/blog/portfolio-items/codeless-node-apis-with-swagger-open-api-specification/ 5 | https://www.udemy.com/course/1076002/ 6 | 7 | ## Getting Started 8 | - Clone the repo. Switch to the todo-api directory in the repo downloaded. 9 | - Install dependencies with `npm install` 10 | - Ensure you have swagger installed globally with `npm install swagger -g` 11 | - Start the node.js application using Swagger with `swagger project start` 12 | - Alternately, you can run the API server using nodejs-dashboard with `npm run dev` 13 | - Ensure you have nodejs-dashboard installed with `npm install nodejs-dashboard -g` 14 | - Launch the swagger editor to view/edit the API definition with `swagger project edit` 15 | 16 | ## Using jmeter 17 | - Download and extract jmeter 18 | - Launch jmeter by navigating to the folder you downloaded, run `bin/jmeter` 19 | - Open the `jmeterTest.jmx` file in this repo to load test the API server 20 | 21 | ## Additional Info: 22 | - Swagger NPM package can be found [here](https://www.npmjs.com/package/swagger) 23 | - Elasticsearch NPM client used is [here](https://www.npmjs.com/package/elasticsearch) 24 | - nodejs-dashboard from Formidable Labs can be found [here](https://github.com/FormidableLabs/nodejs-dashboard) 25 | - Apache jmeter can be found [here](http://jmeter.apache.org/) 26 | -------------------------------------------------------------------------------- /TODO-API-for-swagger-genereated-node-apis-server/jmeterTest.jmx: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | false 7 | false 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | host 18 | localhost 19 | = 20 | 21 | 22 | port 23 | 10010 24 | = 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | Content-Type 33 | application/json 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | ${host} 43 | ${port} 44 | 45 | 46 | http 47 | 48 | 49 | 6 50 | 51 | 52 | 53 | continue 54 | 55 | false 56 | 10 57 | 58 | 50 59 | 5 60 | 1478992185000 61 | 1478992185000 62 | false 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | GET 79 | true 80 | false 81 | true 82 | false 83 | false 84 | 85 | 86 | 87 | 88 | 89 | 200 90 | 91 | Assertion.response_code 92 | false 93 | 16 94 | 95 | 96 | 97 | 98 | true 99 | 100 | 101 | 102 | false 103 | { 104 | "todo_id": ${__Random(99000,99999)}, 105 | "todo": "Test from jmeter", 106 | "author": "jmeter", 107 | "completed": false 108 | } 109 | 110 | = 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | POST 122 | true 123 | false 124 | true 125 | false 126 | false 127 | 128 | 129 | 130 | 131 | todo 132 | $.id 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 | 145 | 146 | 147 | /todo/${todo} 148 | DELETE 149 | true 150 | false 151 | true 152 | false 153 | false 154 | 155 | 156 | 157 | 158 | 159 | "successful":1 160 | 161 | Assertion.response_data 162 | false 163 | 2 164 | 165 | 166 | 167 | 168 | 169 | false 170 | 171 | saveConfig 172 | 173 | 174 | true 175 | true 176 | true 177 | 178 | true 179 | true 180 | true 181 | true 182 | false 183 | true 184 | true 185 | false 186 | false 187 | false 188 | true 189 | false 190 | false 191 | false 192 | true 193 | 0 194 | true 195 | true 196 | true 197 | 198 | 199 | 200 | 201 | 202 | 203 | 204 | 205 | -------------------------------------------------------------------------------- /TODO-API-for-swagger-genereated-node-apis-server/todo-api/.gitignore: -------------------------------------------------------------------------------- 1 | # IDE files 2 | .idea 3 | 4 | # Logs 5 | logs 6 | *.log 7 | 8 | # Runtime data 9 | pids 10 | *.pid 11 | *.seed 12 | 13 | # Directory for instrumented libs generated by jscoverage/JSCover 14 | lib-cov 15 | 16 | # Coverage directory used by tools like istanbul 17 | coverage 18 | 19 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 20 | .grunt 21 | 22 | # Compiled binary addons (http://nodejs.org/api/addons.html) 23 | build/Release 24 | 25 | # Dependency directory 26 | # Commenting this out is preferred by some people, see 27 | # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git 28 | node_modules 29 | 30 | # Users Environment Variables 31 | .lock-wscript 32 | 33 | # Runtime configuration for swagger app 34 | config/runtime.yaml 35 | -------------------------------------------------------------------------------- /TODO-API-for-swagger-genereated-node-apis-server/todo-api/README.md: -------------------------------------------------------------------------------- 1 | # Skeleton project for Node.js Codeless API Creation: Up And Running With Swagger 2 | -------------------------------------------------------------------------------- /TODO-API-for-swagger-genereated-node-apis-server/todo-api/api/controllers/AddTodo.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | var client = require('../helpers/es'); 3 | var monitor = require('../helpers/monitor'); 4 | 5 | module.exports = { 6 | AddTodo : AddTodo 7 | } 8 | 9 | function AddTodo(req, res){ 10 | var start = monitor(); 11 | client.create({ 12 | index: 'todo', 13 | type: 'todo', 14 | id: req.swagger.params.todo.value.todo_id, 15 | body: req.swagger.params.todo.value 16 | }, function(error,response){ 17 | res.header('Content-Type', 'application/json'); 18 | if(error){ 19 | console.log(error); 20 | res.statusCode = 409; 21 | res.end(JSON.stringify(error)); 22 | } else { 23 | console.log(JSON.stringify({'id': req.swagger.params.todo.value.todo_id})); 24 | res.end(JSON.stringify({'id': req.swagger.params.todo.value.todo_id})); 25 | monitor(start, 'AddTodo'); 26 | } 27 | }) 28 | } 29 | -------------------------------------------------------------------------------- /TODO-API-for-swagger-genereated-node-apis-server/todo-api/api/controllers/DeleteTodoById.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | var client = require('../helpers/es'); 3 | var monitor = require('../helpers/monitor'); 4 | 5 | module.exports = { 6 | DeleteTodoById : DeleteTodoById 7 | } 8 | 9 | function DeleteTodoById(req, res) { 10 | var start = monitor(); 11 | console.log(`Deleting todo with id ${req.swagger.params.id.value}`); 12 | client.delete({ 13 | index: 'todo', 14 | type: 'todo', 15 | id: req.swagger.params.id.value 16 | }, function(error, response){ 17 | res.header('Content-Type', 'application/json'); 18 | if(error){ 19 | res.end(JSON.stringify(error)); 20 | } else { 21 | res.end(JSON.stringify(response)); 22 | monitor(start, 'DeleteTodoById'); 23 | } 24 | }); 25 | } 26 | -------------------------------------------------------------------------------- /TODO-API-for-swagger-genereated-node-apis-server/todo-api/api/controllers/FindTodoById.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | var client = require('../helpers/es'); 3 | var monitor = require('../helpers/monitor'); 4 | 5 | module.exports = { 6 | FindTodoById : FindTodoById 7 | } 8 | 9 | function FindTodoById(req, res) { 10 | var start = monitor(); 11 | console.log(`Getting Todo with id ${req.swagger.params.id.value}`); 12 | client.get({ 13 | index: 'todo', 14 | type: 'todo', 15 | id: req.swagger.params.id.value 16 | }, function(error, response){ 17 | res.header('Content-Type', 'application/json'); 18 | if(error){ 19 | res.end(JSON.stringify(error)); 20 | } else { 21 | res.end(JSON.stringify(response._source)); 22 | monitor(start, 'FindTodoById'); 23 | } 24 | }); 25 | } 26 | -------------------------------------------------------------------------------- /TODO-API-for-swagger-genereated-node-apis-server/todo-api/api/controllers/GetAllTodos.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | var client = require('../helpers/es'); 3 | var monitor = require('../helpers/monitor'); 4 | 5 | module.exports = { 6 | GetAllTodos : GetAllTodos 7 | }; 8 | 9 | function GetAllTodos(req, res) { 10 | var start = monitor(); 11 | client.search({ 12 | index:'todo', 13 | type: 'todo', 14 | q: '*', 15 | _sourceInclude: 'todo_id, todo, completed, tags, author, completeddate, duedate' 16 | }, function(error, response){ 17 | if(error){ 18 | res.end(JSON.stringify(error)); 19 | } else { 20 | var results = []; 21 | results = response.hits.hits.map(function(hit){ return hit._source }); 22 | res.header('Content-Type', 'application/json'); 23 | res.end(JSON.stringify(results)); 24 | monitor(start, 'GetAllTodos'); 25 | } 26 | }); 27 | } 28 | -------------------------------------------------------------------------------- /TODO-API-for-swagger-genereated-node-apis-server/todo-api/api/controllers/README.md: -------------------------------------------------------------------------------- 1 | Place your controllers in this directory. 2 | -------------------------------------------------------------------------------- /TODO-API-for-swagger-genereated-node-apis-server/todo-api/api/controllers/UpdateTodoById.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | var client = require('../helpers/es'); 3 | var monitor = require('../helpers/monitor'); 4 | 5 | module.exports = { 6 | UpdateTodoById : UpdateTodoById 7 | } 8 | 9 | function UpdateTodoById(req, res){ 10 | var start = monitor(); 11 | client.update({ 12 | index: 'todo', 13 | type: 'todo', 14 | id: req.swagger.params.id.value, 15 | body: { 16 | doc: req.swagger.params.updated_todo.value 17 | } 18 | }, function(error, response) { 19 | res.header('Content-Type', 'application/json'); 20 | if(error) { 21 | res.statusCode = 400; 22 | res.end(JSON.stringify(error)); 23 | } else { 24 | res.end(); 25 | monitor(start, 'UpdateTodoById'); 26 | } 27 | }); 28 | } 29 | -------------------------------------------------------------------------------- /TODO-API-for-swagger-genereated-node-apis-server/todo-api/api/controllers/hello_world.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | /* 3 | 'use strict' is not required but helpful for turning syntactical errors into true errors in the program flow 4 | https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Strict_mode 5 | */ 6 | 7 | /* 8 | Modules make it possible to import JavaScript files into your application. Modules are imported 9 | using 'require' statements that give you a reference to the module. 10 | 11 | It is a good idea to list the modules that your application depends on in the package.json in the project root 12 | */ 13 | var util = require('util'); 14 | 15 | /* 16 | Once you 'require' a module you can reference the things that it exports. These are defined in module.exports. 17 | 18 | For a controller in a127 (which this is) you should export the functions referenced in your Swagger document by name. 19 | 20 | Either: 21 | - The HTTP Verb of the corresponding operation (get, put, post, delete, etc) 22 | - Or the operationId associated with the operation in your Swagger document 23 | 24 | In the starter/skeleton project the 'get' operation on the '/hello' path has an operationId named 'hello'. Here, 25 | we specify that in the exports of this module that 'hello' maps to the function named 'hello' 26 | */ 27 | module.exports = { 28 | hello: hello 29 | }; 30 | 31 | /* 32 | Functions in a127 controllers used for operations should take two parameters: 33 | 34 | Param 1: a handle to the request object 35 | Param 2: a handle to the response object 36 | */ 37 | function hello(req, res) { 38 | // variables defined in the Swagger document can be referenced using req.swagger.params.{parameter_name} 39 | var name = req.swagger.params.name.value || 'stranger'; 40 | var hello = util.format('Hello, %s!', name); 41 | 42 | // this sends back a JSON response which is a single string 43 | res.json(hello); 44 | } 45 | -------------------------------------------------------------------------------- /TODO-API-for-swagger-genereated-node-apis-server/todo-api/api/helpers/README.md: -------------------------------------------------------------------------------- 1 | Place helper files in this directory. 2 | -------------------------------------------------------------------------------- /TODO-API-for-swagger-genereated-node-apis-server/todo-api/api/helpers/es.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | var Elasticsearch = require('elasticsearch'); 4 | var client = new Elasticsearch.Client({ 5 | host: 'localhost:9200', 6 | log: 'error' 7 | }); 8 | 9 | module.exports = client; 10 | -------------------------------------------------------------------------------- /TODO-API-for-swagger-genereated-node-apis-server/todo-api/api/helpers/monitor.js: -------------------------------------------------------------------------------- 1 | var client = require('../helpers/es'); 2 | 3 | var monitor = function(start, tag) { 4 | if (start) { 5 | var endTime = process.hrtime(start); 6 | var duration = parseInt((endTime[0] * 1000) + (endTime[1]/1000000)); 7 | console.log(`Duration for ${tag}: ${duration} msec`); 8 | client.create({ 9 | index: 'monitoring', 10 | type: 'todo-api', 11 | id: new Date().getTime(), 12 | body: { 'duration': duration, 'tag': tag } 13 | }) 14 | } else { 15 | return process.hrtime(); 16 | } 17 | } 18 | 19 | module.exports = monitor; 20 | -------------------------------------------------------------------------------- /TODO-API-for-swagger-genereated-node-apis-server/todo-api/api/mocks/GetAllTodos.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | module.exports = { 4 | GetAllTodos : GetAllTodos 5 | } 6 | 7 | function GetAllTodos(req, res, next) { 8 | res.json([ 9 | { 10 | todo_id: 0, 11 | todo: "Get some milk", 12 | author: "Luke Angel", 13 | createddate: "2016-11-01T23:15:00.000Z", 14 | duedate: "2016-11-08T08:00:00.000Z", 15 | completed: false 16 | }, 17 | { 18 | todo_id: 1, 19 | todo: "Get some cereal", 20 | author: "Austin", 21 | createddate: "2016-11-01T23:15:00.000Z", 22 | duedate: "2016-11-08T08:00:00.000Z", 23 | completed: false 24 | } 25 | ]) 26 | } 27 | -------------------------------------------------------------------------------- /TODO-API-for-swagger-genereated-node-apis-server/todo-api/api/mocks/README.md: -------------------------------------------------------------------------------- 1 | Place controllers for mock mode in this directory. 2 | -------------------------------------------------------------------------------- /TODO-API-for-swagger-genereated-node-apis-server/todo-api/api/swagger/swagger.yaml: -------------------------------------------------------------------------------- 1 | swagger: "2.0" 2 | info: 3 | version: "0.0.1" 4 | title: Todo API 5 | # during dev, should point to your local machine 6 | host: localhost:10010 7 | # basePath prefixes all resource paths 8 | basePath: / 9 | # 10 | schemes: 11 | # tip: remove http to make production-grade 12 | - http 13 | - https 14 | # format of bodies a client can send (Content-Type) 15 | consumes: 16 | - application/json 17 | # format of the responses to the client (Accepts) 18 | produces: 19 | - application/json 20 | paths: 21 | /: 22 | get: 23 | description: "This endpoint returns all todos available in the database" 24 | operationId: "GetAllTodos" 25 | parameters: [] 26 | responses: 27 | 200: 28 | description: "An array of todos" 29 | schema: 30 | type: "array" 31 | items: 32 | $ref: "#/definitions/Todo" 33 | x-swagger-router-controller: "GetAllTodos" 34 | post: 35 | description: "Add a new Todo" 36 | operationId: "AddTodo" 37 | produces: 38 | - "application/json" 39 | parameters: 40 | - in: "body" 41 | name: "todo" 42 | description: "the Todo to be added" 43 | required: true 44 | schema: 45 | $ref: "#/definitions/Todo" 46 | responses: 47 | 200: 48 | description: "Successful Todo add" 49 | schema: 50 | $ref: "#/definitions/AddResponse" 51 | x-swagger-router-controller: "AddTodo" 52 | /todo/{id}: 53 | get: 54 | description: "Retrieve a single todo by id" 55 | operationId: "FindTodoById" 56 | produces: 57 | - "application/json" 58 | parameters: 59 | - name: "id" 60 | in: "path" 61 | description: "ID of the todo to get" 62 | required: true 63 | type: "integer" 64 | format: "int64" 65 | responses: 66 | 200: 67 | description: "Todo response" 68 | schema: 69 | $ref: "#/definitions/Todo" 70 | x-swagger-router-controller: "FindTodoById" 71 | delete: 72 | description: "Delete a todo by Id" 73 | operationId: "DeleteTodoById" 74 | parameters: 75 | - name: "id" 76 | in: "path" 77 | description: "id of the todo to delete" 78 | required: true 79 | type: "integer" 80 | format: "int64" 81 | responses: 82 | 204: 83 | description: "todo deleted" 84 | x-swagger-router-controller: "DeleteTodoById" 85 | put: 86 | description: "Update a single to by id" 87 | operationId: "UpdateTodoById" 88 | parameters: 89 | - name: "id" 90 | in: "path" 91 | description: "Id of the todo being updated" 92 | required: true 93 | type: "integer" 94 | format: "int64" 95 | - name: "updated_todo" 96 | in: "body" 97 | description: "the updated todo" 98 | required: true 99 | schema: 100 | $ref: "#/definitions/Todo" 101 | responses: 102 | 200: 103 | description: "Todo updated" 104 | 400: 105 | description: "Yikes! An error!" 106 | x-swagger-router-controller: "UpdateTodoById" 107 | /swagger: 108 | x-swagger-pipe: swagger_raw 109 | # complex objects have schema definitions 110 | definitions: 111 | Todo: 112 | type: "object" 113 | properties: 114 | todo_id: 115 | type: "integer" 116 | description: "Id for the todo" 117 | todo: 118 | type: "string" 119 | description: "The todo item" 120 | datecreated: 121 | type: "string" 122 | format: "date-time" 123 | description: "Timestamp when the Todo was created. Set by server" 124 | author: 125 | type: "string" 126 | description: "Creator or owner of the todo" 127 | duedate: 128 | type: "string" 129 | format: "date-time" 130 | description: "When the todo is due" 131 | completed: 132 | type: "boolean" 133 | description: "Indicates if the todo has been completed or not" 134 | AddResponse: 135 | type: "object" 136 | properties: 137 | id: 138 | type: "integer" 139 | description: "Id of the todo added" -------------------------------------------------------------------------------- /TODO-API-for-swagger-genereated-node-apis-server/todo-api/app.js: -------------------------------------------------------------------------------- 1 | 'use strict'; 2 | 3 | var SwaggerExpress = require('swagger-express-mw'); 4 | var app = require('express')(); 5 | var cors = require('cors'); 6 | module.exports = app; // for testing 7 | 8 | var config = { 9 | appRoot: __dirname // required config 10 | }; 11 | 12 | SwaggerExpress.create(config, function(err, swaggerExpress) { 13 | if (err) { throw err; } 14 | app.use(cors()); 15 | 16 | // install middleware 17 | swaggerExpress.register(app); 18 | 19 | var port = process.env.PORT || 10010; 20 | app.listen(port); 21 | 22 | if (swaggerExpress.runner.swagger.paths['/hello']) { 23 | console.log('try this:\ncurl http://127.0.0.1:' + port + '/hello?name=Scott'); 24 | } 25 | }); 26 | -------------------------------------------------------------------------------- /TODO-API-for-swagger-genereated-node-apis-server/todo-api/config/README.md: -------------------------------------------------------------------------------- 1 | Place configuration files in this directory. 2 | -------------------------------------------------------------------------------- /TODO-API-for-swagger-genereated-node-apis-server/todo-api/config/default.yaml: -------------------------------------------------------------------------------- 1 | # swagger configuration file 2 | 3 | # values in the swagger hash are system configuration for swagger-node 4 | swagger: 5 | 6 | fittingsDirs: [ api/fittings ] 7 | defaultPipe: null 8 | swaggerControllerPipe: swagger_controllers # defines the standard processing pipe for controllers 9 | 10 | # values defined in the bagpipes key are the bagpipes pipes and fittings definitions 11 | # (see https://github.com/apigee-127/bagpipes) 12 | bagpipes: 13 | 14 | _router: 15 | name: swagger_router 16 | mockMode: false 17 | mockControllersDirs: [ api/mocks ] 18 | controllersDirs: [ api/controllers ] 19 | 20 | _swagger_validate: 21 | name: swagger_validator 22 | validateResponse: true 23 | 24 | # pipe for all swagger-node controllers 25 | swagger_controllers: 26 | - onError: json_error_handler 27 | - cors 28 | - swagger_security 29 | - _swagger_validate 30 | - express_compatibility 31 | - _router 32 | 33 | # pipe to serve swagger (endpoint is in swagger.yaml) 34 | swagger_raw: 35 | name: swagger_raw 36 | 37 | # any other values in this file are just loaded into the config for application access... 38 | -------------------------------------------------------------------------------- /TODO-API-for-swagger-genereated-node-apis-server/todo-api/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "todo-api", 3 | "version": "0.0.1", 4 | "private": true, 5 | "description": "Node.js Codeless API Creation: Up And Running With Swagger", 6 | "keywords": [], 7 | "author": "Luke Angel - BTREEPRESS.com - BTREE.co - LUKENAGEL.co", 8 | "license": "", 9 | "main": "app.js", 10 | "dependencies": { 11 | "axios": "^0.15.2", 12 | "cors": "^2.8.1", 13 | "elasticsearch": "^12.0.1", 14 | "express": "^4.12.3", 15 | "swagger-express-mw": "^0.1.0" 16 | }, 17 | "devDependencies": { 18 | "nodejs-dashboard": "^0.1.2", 19 | "should": "^7.1.0", 20 | "supertest": "^1.0.0" 21 | }, 22 | "scripts": { 23 | "start": "node app.js", 24 | "dev": "nodejs-dashboard node app.js", 25 | "test": "swagger project test" 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /TODO-API-for-swagger-genereated-node-apis-server/todo-api/test/api/controllers/README.md: -------------------------------------------------------------------------------- 1 | Place your controller tests in this directory. 2 | -------------------------------------------------------------------------------- /TODO-API-for-swagger-genereated-node-apis-server/todo-api/test/api/controllers/hello_world.js: -------------------------------------------------------------------------------- 1 | var should = require('should'); 2 | var request = require('supertest'); 3 | var server = require('../../../app'); 4 | 5 | describe('controllers', function() { 6 | 7 | describe('hello_world', function() { 8 | 9 | describe('GET /hello', function() { 10 | 11 | it('should return a default string', function(done) { 12 | 13 | request(server) 14 | .get('/hello') 15 | .set('Accept', 'application/json') 16 | .expect('Content-Type', /json/) 17 | .expect(200) 18 | .end(function(err, res) { 19 | should.not.exist(err); 20 | 21 | res.body.should.eql('Hello, stranger!'); 22 | 23 | done(); 24 | }); 25 | }); 26 | 27 | it('should accept a name parameter', function(done) { 28 | 29 | request(server) 30 | .get('/hello') 31 | .query({ name: 'Scott'}) 32 | .set('Accept', 'application/json') 33 | .expect('Content-Type', /json/) 34 | .expect(200) 35 | .end(function(err, res) { 36 | should.not.exist(err); 37 | 38 | res.body.should.eql('Hello, Scott!'); 39 | 40 | done(); 41 | }); 42 | }); 43 | 44 | }); 45 | 46 | }); 47 | 48 | }); 49 | -------------------------------------------------------------------------------- /TODO-API-for-swagger-genereated-node-apis-server/todo-api/test/api/helpers/README.md: -------------------------------------------------------------------------------- 1 | Place your helper tests in this directory. 2 | -------------------------------------------------------------------------------- /docker-ElasticSearch/ReadMe.md: -------------------------------------------------------------------------------- 1 | # !!!!! WARING NON SUPPORTED SECTION !!!!! 2 | 3 | Going over installing docker or elastic search is beyond the scope of the course. Here is how I was running my instance. This is not the point of the course. I just added to be friendly. 4 | 5 | # Want to learn more about Docker? 6 | 7 | Check out my courses 8 | 9 | **Docker for Developers - Newest Version 1.12 with Swarm Mode** 10 | 11 | https://www.udemy.com/course/909244/manage/goals/ 12 | 13 | **Docker and Continuous Integration: Code, Build, Test, Deploy** 14 | 15 | https://www.udemy.com/course/1031292/ 16 | 17 | 18 | 19 | 20 | # #1 Install Docker 21 | 22 | Go here and install docker 23 | 24 | https://www.docker.com/products/overview 25 | 26 | # #2 Run Docker-Compose Up 27 | Once installed open a command prompt/ Terminal in the folder you have the docker-compose.yml file in and and run 28 | 29 | 30 | ### Start the Cluster 31 | docker-compose up 32 | 33 | ### Verify its up 34 | To verify its up go to localhost:9200 / 127.0.0.1 / or whatever your dockers root ip and then port 9200 mine looks like this: 35 | 36 | **url:** http://docker.local:9200/ 37 | 38 | **username:** elastic 39 | 40 | **password:** changeme 41 | 42 | ### Stop the Cluster 43 | 44 | To stop the cluster, type docker-compose down. Data volumes will persist, so it’s possible to start the cluster again with the same data using docker-compose up. To destroy the cluster and the data volumes just type docker-compose down -v. 45 | 46 | -------------------------------------------------------------------------------- /docker-ElasticSearch/docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: '2' 2 | services: 3 | elasticsearch1: 4 | image: docker.elastic.co/elasticsearch/elasticsearch:5.1.2 5 | container_name: elasticsearch1 6 | environment: 7 | - cluster.name=docker-cluster 8 | - bootstrap.memory_lock=true 9 | - "ES_JAVA_OPTS=-Xms512m -Xmx512m" 10 | ulimits: 11 | memlock: 12 | soft: -1 13 | hard: -1 14 | nofile: 15 | soft: 65536 16 | hard: 65536 17 | mem_limit: 1g 18 | cap_add: 19 | - IPC_LOCK 20 | volumes: 21 | - esdata1:/usr/share/elasticsearch/data 22 | ports: 23 | - 9200:9200 24 | networks: 25 | - esnet 26 | elasticsearch2: 27 | image: docker.elastic.co/elasticsearch/elasticsearch:5.1.2 28 | environment: 29 | - cluster.name=docker-cluster 30 | - bootstrap.memory_lock=true 31 | - "ES_JAVA_OPTS=-Xms512m -Xmx512m" 32 | - "discovery.zen.ping.unicast.hosts=elasticsearch1" 33 | ulimits: 34 | memlock: 35 | soft: -1 36 | hard: -1 37 | nofile: 38 | soft: 65536 39 | hard: 65536 40 | mem_limit: 1g 41 | cap_add: 42 | - IPC_LOCK 43 | volumes: 44 | - esdata2:/usr/share/elasticsearch/data 45 | networks: 46 | - esnet 47 | 48 | volumes: 49 | esdata1: 50 | driver: local 51 | esdata2: 52 | driver: local 53 | 54 | networks: 55 | esnet: 56 | driver: bridge --------------------------------------------------------------------------------