如何添加rest api图像,以便我们可以将其添加到我们的GitHub中以供稍后参考

问题描述 投票:0回答:1

我创建了一个项目,最后为了测试我拍摄了 REST API 屏幕截图。我想知道将所有这些图像保存在一个地方的最佳方法是什么。 在自述文件中还是在其他地方?

在文件夹或自述文件中。

已经谢谢你了。如果您有链接,请分享,以便我参考。

spring-boot github readme
1个回答
0
投票

请在下面找到详细信息 在 GitHub 上整理并轻松访问的 REST API 屏幕截图将存储在项目存储库内的文件夹中,然后在

README.md
文件中引用。

README 文件代码在本地编写或直接到 GitHub repo

## REST API Testing Screenshots

Here are the screenshots taken while testing the REST APIs:

### Endpoint: /api/getData
![Get Data API](./images/get-data-api.png)

### Endpoint: /api/postData
![Post Data API](./images/post-data-api.png)

将文件夹和更新的 README.md 添加到您的 GitHub 存储库:

git add images/ README.md
git commit -m "Add API screenshots and update README" //this is a comment according to modify
git push origin main/master (Branch)

官方 GitHub Markdown 指南中的 GitHub README 文件。

© www.soinside.com 2019 - 2024. All rights reserved.