TheCloud/v
1
0
Fork 0
mirror of https://github.com/vlang/v.git synced 2025-09-11 00:20:26 -04:00
Code Issues Packages Projects Releases Wiki Activity

vweb, x.vweb: improve descriptions (#21155)

Browse Source
This commit is contained in:
Kim Shrier 2024-04-01 10:48:46 -06:00 committed by GitHub
parent 9704a01406
commit ecbd214ee1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
vlib/vweb/README.md
View File

@ -20,10 +20,10 @@ in the browser. No need to quit the app, rebuild it, and refresh the page in the
- **Very fast** performance of C on the web. - **Very fast** performance of C on the web.
- **Small binary** hello world website is <100 KB. - **Small binary** hello world website is <100 KB.
- **Easy to deploy** just one binary file that also includes all templates. No need to install any
dependencies.
- **Templates are precompiled** all errors are visible at compilation time, not at runtime. - **Templates are precompiled** all errors are visible at compilation time, not at runtime.
- **Multithreaded** by default - **Multithreaded** by default
- **Easy to deploy** just one binary file that also includes all templates. No need to install any
dependencies.
### Examples ### Examples
@ -69,7 +69,7 @@ fn new_app() &App {
@['/'] @['/']
pub fn (mut app App) page_home() vweb.Result { pub fn (mut app App) page_home() vweb.Result {
// all this constants can be accessed by src/templates/page/home.html file. // all these constants can be accessed by src/templates/page/home.html file.
page_title := 'V is the new V' page_title := 'V is the new V'
v_url := 'https://github.com/vlang/v' v_url := 'https://github.com/vlang/v'
@ -210,8 +210,8 @@ fn (mut app App) create_product() vweb.Result {
#### - Parameters #### - Parameters
Parameters are passed directly in endpoint route using colon sign `:` and received using the same Parameters are passed directly in the endpoint route using a colon sign `:` and received
name at function using the same name in the function.
To pass a parameter to an endpoint, you simply define it inside an attribute, e. g. To pass a parameter to an endpoint, you simply define it inside an attribute, e. g.
`['/hello/:user]`. `['/hello/:user]`.
After it is defined in the attribute, you have to add it as a function parameter. After it is defined in the attribute, you have to add it as a function parameter.
@ -230,9 +230,9 @@ You have access to the raw request data such as headers
or the request body by accessing `app` (which is `vweb.Context`). or the request body by accessing `app` (which is `vweb.Context`).
If you want to read the request body, you can do that by calling `app.req.data`. If you want to read the request body, you can do that by calling `app.req.data`.
To read the request headers, you just call `app.req.header` and access the To read the request headers, you just call `app.req.header` and access the
header you want example. `app.req.header.get(.content_type)`. See `struct Header` header you want, for example `app.req.header.get(.content_type)`. See `struct Header`
for all available methods (`v doc net.http Header`). for all available methods (`v doc net.http Header`).
It has, too, fields for the `query`, `form`, `files`. It also has fields for the `query`, `form`, and `files`.
#### - Parameter Arrays #### - Parameter Arrays

4
vlib/x/vweb/README.md
View File

@ -6,11 +6,11 @@ features.
## Features ## Features
- **Very fast** performance of C on the web. - **Very fast** performance of C on the web.
- **Easy to deploy** just one binary file that also includes all templates. No need to install any
dependencies.
- **Templates are precompiled** all errors are visible at compilation time, not at runtime. - **Templates are precompiled** all errors are visible at compilation time, not at runtime.
- **Middleware** functionality similar to other big frameworks. - **Middleware** functionality similar to other big frameworks.
- **Controllers** to split up your apps logic. - **Controllers** to split up your apps logic.
- **Easy to deploy** just one binary file that also includes all templates. No need to install any
dependencies.
## Quick Start ## Quick Start