当前位置:首页 > 文章列表 > 文章 > 前端 > Astro 中的 API 密钥和环境变量:完整安全指南

Astro 中的 API 密钥和环境变量:完整安全指南

来源:dev.to 2024-12-14 09:16:02 0浏览 收藏

golang学习网今天将给大家带来《Astro 中的 API 密钥和环境变量:完整安全指南》,感兴趣的朋友请继续看下去吧!以下内容将会涉及到等等知识点,如果你是正在学习文章或者已经是大佬级别了,都非常欢迎也希望大家都能给我建议评论哈~希望能帮助到大家!

Astro 中的 API 密钥和环境变量:完整安全指南

当我们使用 astro 开发 web 应用程序时,我们经常需要与外部 api 和服务进行交互。安全地管理凭据和 api 密钥对于保护我们的应用程序至关重要。在本指南中,我们将探索在 astro 项目中管理 api 密钥和环境变量的最佳实践。

astro 中的环境变量

基本配置

在 astro 中,环境变量的处理方式与其他现代框架类似。首先,我们在项目的根目录中创建一个 .env 文件:

# .env
public_api_url=https://api.ejemplo.com
private_api_key=tu_clave_secreta
database_url=postgresql://usuario:password@localhost:5432/db

对于 typescript,建议创建一个 env.d.ts 文件来输入我们的变量:

/// <reference types="astro/client" />
interface importmetaenv {
  readonly database_url: string;
  readonly private_api_key: string;
  readonly public_api_url: string;
}

interface importmeta {
  readonly env: importmetaenv;
}

访问变量

在 astro 中,我们可以根据上下文以不同的方式访问环境变量:

---
// en archivos .astro
const apikey = import.meta.env.private_api_key;
const publicurl = import.meta.env.public_api_url;
---
// en archivos .ts o .js
const apikey = import.meta.env.private_api_key;

前端安全

公共变量与私有变量

astro 遵循环境变量的重要约定:

  • public_*:可在客户端和服务器上访问
  • 无 public_ 前缀:只能在服务器上访问
# .env
public_api_url=https://api.publica.com    # ✅ visible en el cliente
private_api_key=secreto123                # ⛔ solo servidor

保护敏感密钥

要处理需要身份验证的 api,我们必须创建无服务器端点:

// src/pages/api/data.ts
export async function get() {
  try {
    const response = await fetch('https://api.externa.com/data', {
      headers: {
        'authorization': `bearer ${import.meta.env.private_api_key}`
      }
    });

    const data = await response.json();
    return new response(json.stringify(data), {
      status: 200,
      headers: {
        'content-type': 'application/json'
      }
    });
  } catch (error) {
    return new response(json.stringify({ error: 'error al obtener datos' }), {
      status: 500
    });
  }
}

最佳实践

1.环境变量的验证

在应用程序开始时实现验证功能:

// src/utils/validateenv.ts
export function validateenv() {
  const requiredenvvars = [
    'database_url',
    'private_api_key',
    'public_api_url'
  ];

  for (const envvar of requiredenvvars) {
    if (!import.meta.env[envvar]) {
      throw new error(`la variable de entorno ${envvar} es requerida`);
    }
  }
}

// src/pages/index.astro
---
import { validateenv } from '../utils/validateenv';

if (import.meta.env.mode === 'development') {
  validateenv();
}
---

2. 多重环境管理

为每个环境创建不同的文件:

.env                # variables por defecto
.env.development    # variables de desarrollo
.env.production     # variables de producción
.env.local          # variables locales (ignoradas en git)

3.环境变量模板

提供.env.example文件:

# .env.example
public_api_url=https://api.ejemplo.com
private_api_key=tu_clave_aqui
database_url=postgresql://usuario:password@localhost:5432/db

4.git配置

确保在 .gitignore 中包含敏感文件:

# .gitignore
.env
.env.local
.env.*.local

与外部服务集成

条纹示例

// src/pages/api/create-payment.ts
import stripe from 'stripe';

export async function post({ request }) {
  const stripe = new stripe(import.meta.env.stripe_secret_key);

  try {
    const { amount, currency } = await request.json();

    const paymentintent = await stripe.paymentintents.create({
      amount,
      currency
    });

    return new response(json.stringify({ clientsecret: paymentintent.client_secret }), {
      status: 200
    });
  } catch (error) {
    return new response(json.stringify({ error: error.message }), {
      status: 400
    });
  }
}

firebase 示例

// src/lib/firebase.ts
import { initializeapp } from 'firebase/app';
import { getfirestore } from 'firebase/firestore';

const firebaseconfig = {
  apikey: import.meta.env.public_firebase_api_key,
  authdomain: import.meta.env.public_firebase_auth_domain,
  projectid: import.meta.env.public_firebase_project_id,
};

export const app = initializeapp(firebaseconfig);
export const db = getfirestore(app);

部署和 ci/cd

vercel 中的配置

# configurar variables en vercel cli
vercel env add private_api_key
vercel env add database_url

github 操作

# .github/workflows/deploy.yml
name: deploy
on:
  push:
    branches: [main]
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: deploy to vercel
        env:
          vercel_token: ${{ secrets.vercel_token }}
          private_api_key: ${{ secrets.private_api_key }}
          database_url: ${{ secrets.database_url }}
        run: vercel deploy --prod --token=$vercel_token

额外的安全提示

  1. 密钥轮换:实现定期轮换 api 密钥的系统
// src/utils/rotateapikey.ts
async function rotateapikey() {
  const currentkey = import.meta.env.private_api_key;
  const expirationdays = 30;

  // lógica para verificar la edad de la clave
  // implementar rotación si es necesario
}
  1. 使用情况监控:实施日志记录以检测误用
// src/middleware/apiLogger.ts
export async function apiLogger(request, apiName) {
  console.log(`[${new Date().toISOString()}] API Call: ${apiName}`);
  // Implementar logging más detallado según necesidades
}

api 密钥和环境变量的安全处理对于任何现代 web 应用程序都至关重要。通过遵循 astro 的这些最佳实践,我们可以:

  • 确保我们的凭证安全
  • 按环境单独配置
  • 实施稳健的验证
  • 安全地集成外部服务

今天带大家了解了的相关知识,希望对你有所帮助;关于文章的技术知识我们会一点点深入介绍,欢迎大家关注golang学习网公众号,一起学习编程~

版本声明
本文转载于:dev.to 如有侵犯,请联系study_golang@163.com删除
Vue路由与Nginx路由冲突,如何解决?Vue路由与Nginx路由冲突,如何解决?
上一篇
Vue路由与Nginx路由冲突,如何解决?
上海:推动三年内实现 3 个以上电视频道采取 4K 超高清方式播出
下一篇
上海:推动三年内实现 3 个以上电视频道采取 4K 超高清方式播出
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    542次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    511次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    498次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    484次学习
查看更多
AI推荐
  • 千音漫语:智能声音创作助手,AI配音、音视频翻译一站搞定!
    千音漫语
    千音漫语,北京熠声科技倾力打造的智能声音创作助手,提供AI配音、音视频翻译、语音识别、声音克隆等强大功能,助力有声书制作、视频创作、教育培训等领域,官网:https://qianyin123.com
    116次使用
  • MiniWork:智能高效AI工具平台,一站式工作学习效率解决方案
    MiniWork
    MiniWork是一款智能高效的AI工具平台,专为提升工作与学习效率而设计。整合文本处理、图像生成、营销策划及运营管理等多元AI工具,提供精准智能解决方案,让复杂工作简单高效。
    111次使用
  • NoCode (nocode.cn):零代码构建应用、网站、管理系统,降低开发门槛
    NoCode
    NoCode (nocode.cn)是领先的无代码开发平台,通过拖放、AI对话等简单操作,助您快速创建各类应用、网站与管理系统。无需编程知识,轻松实现个人生活、商业经营、企业管理多场景需求,大幅降低开发门槛,高效低成本。
    128次使用
  • 达医智影:阿里巴巴达摩院医疗AI影像早筛平台,CT一扫多筛癌症急慢病
    达医智影
    达医智影,阿里巴巴达摩院医疗AI创新力作。全球率先利用平扫CT实现“一扫多筛”,仅一次CT扫描即可高效识别多种癌症、急症及慢病,为疾病早期发现提供智能、精准的AI影像早筛解决方案。
    120次使用
  • 智慧芽Eureka:更懂技术创新的AI Agent平台,助力研发效率飞跃
    智慧芽Eureka
    智慧芽Eureka,专为技术创新打造的AI Agent平台。深度理解专利、研发、生物医药、材料、科创等复杂场景,通过专家级AI Agent精准执行任务,智能化工作流解放70%生产力,让您专注核心创新。
    124次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议隐私政策
返回登录
  • 重置密码