编程语言
首页 > 编程语言> > 在API文档中完美调整图像大小

在API文档中完美调整图像大小

作者:互联网

Bump.sh如何默认渲染图像

通常,在降价中,您将使用此语法来添加图像

![Alt text](/path/to/image.jpg "Image title")

默认情况下,Bump.sh允许浏览器决定如何显示生成的html <img src="image.url">。例如,如果图像在表格单元格中,它将被限制为表格单元格的大小,如果在段落中,它将使用默认图像大小。

但是,您现在可以自己决定图像大小。

如何在API文档中自定义图像大小

现在,您可以使用a=dimension参数进一步进行个性化,该参数允许您手动决定如何在文档中显示图像。

=dimension只需通过允许您在结束括号之前提供额外的维度信息来扩展众所周知的Markdown语法

![Alt text](/path/to/image.jpg "Image title" =dimension)

例如,如果您想显示100像素高、50像素宽的图像,您可以写

![Alt text](/path/to/image.jpg "Image title" =100pxx50px)

=dimension uses the following syntax =[width][unit]x[height][unit] and is itself completely optional as well as almost all its parameters: just width or xheight are mandatory. If you don't specify width or height, the other value will be a ratio calculated from the original size of the image so it doesn't shrink.

告诉这个可能会令人困惑,所以这里有几个例子可以更好地了解你可以用这个=dimension参数做什么:

让我们拍这张海绵宝宝的毛绒照片。查看它默认呈现方式:

 

现在让我们来玩玩=dimension参数!

=100pxx50px   # with everything
=100x50     # without unit

 

=100        # without height (x separator not needed) and unit
=100px      # without height

 

=x50        # without width and unit
=x50px      # without width

 

请注意,不指定单位将回退到像素。

它还支持所有CSS长度单位,因此您可以使用像素、%或您习惯的任何其他绝对或相对单位的px

与上面相同的图像,=dimension=200cm
 

始终确保您使用的属性由不同的浏览器处理,因为它可能有所不同。

您可以在文档中找到有关此新图像大小化功能行为的扩展描述。

尝试使用您自己的API文档

Bump.sh允许您预览文档的外观。

您可以在编辑API合同时预览图像将如何呈现,或在测试中使用Bump.sh CLI命令

npm install -g bump-cli   ## installs bump.sh cli

bump preview --live --open openapi-definition.json

选项--open将在默认浏览器中打开预览,在文件中保存编辑后,--live将自动更新浏览器中的预览。

标签:API,渲染,自定义
来源: